Stores
Store, often referred to as a brick-and-mortar store, is a retail environment that requires physical space to display and sell products. Stores can be free-standing structures, tenants in a mall or shopping center or linked to venues. Store of various types like Physical stores. handled by a set of endpoints, This page covers Store endpoints that are created to manage Store operations programmatically
Get all physical stores
This endpoint allows you to Get all physical stores.
Developers - API Operations:
| Operation | Endpoint | Response |
|---|---|---|
| Get Stores | /api/v2/stores/all | Get all physical stores. |
Response Properties
- Name
statusCode- Type
- number
- Description
Status code of the response
- Name
status- Type
- string
- Description
Status of the response
- Name
errors- Type
- array
- Description
List of errors in the response
- Name
success- Type
- boolean
- Description
Success status of the response
- Name
message- Type
- string
- Description
Message of the response
- Name
messageCode- Type
- string
- Description
Message code of the response
- Name
result- Type
- array
- Description
Result of the response
- Name
id- Type
- string
- Description
Id to identify the address
- Name
name- Type
- string
- Description
Name of the product
- Name
address1- Type
- string
- Description
Address Line 1 provided by the user
- Name
address2- Type
- Description
Address Line 2 provided by the user
- Name
city- Type
- string
- Description
City name provided by the user
- Name
state- Type
- string
- Description
State name provided by the user
- Name
postCode- Type
- string
- Description
Post code provided by the user
- Name
yourId- Type
- string
- Description
Id of the customer
- Name
distanceFromPostCode- Type
- string
- Description
Distance of the store from the Postal code
- Name
distanceUnit- Type
- string
- Description
Unit of the distance provided
- Name
shippingPlanId- Type
- string
- Description
Shipping plan Id used to identify the shipping plan
- Name
type- Type
- string
- Description
Type of stores for the order
- Name
leadTimeUnit- Type
- string
- Description
Unit of measurement for Lead time
- Name
leadTimeMin- Type
- number
- Description
The minimum lead time for the order to be delivered
- Name
leadTimeMax- Type
- number
- Description
The maximum lead time for the order to be delivered
- Name
deliveryOption- Type
- string
- Description
Delivery option selected bu the user
- Name
shippingAddressId- Type
- string
- Description
Shipping address Id used to identify the shipping address
- Name
openingHours- Type
- string
- Description
Opening hours of the store
- Name
slots- Type
- array
- Description
List of slots available at the store
- Name
slot- Type
- string
- Description
Available slot of the store
- Name
slotMessage- Type
- string
- Description
Message for the available slot of the store
- Name
whyDelayMsg1- Type
- string
- Description
Message stating the reason for delay
- Name
whyDelayMsg2- Type
- string
- Description
Message stating the reason for delay
- Name
whyDelayMsg3- Type
- string
- Description
Message stating the reason for delay
- Name
selectedSlot- Type
- string
- Description
Slot selected by the user
- Name
phoneNo- Type
- string
- Description
Phone number of the store
- Name
timeslotActual- Type
- string
- Description
Actual time slot of the store
- Name
latitude- Type
- string
- Description
Latitude of the geographical location of the store
- Name
longitude- Type
- string
- Description
Longitude of the geographical location of the store
- Name
image- Type
- string
- Description
File name/URL of the image of the store
- Name
country- Type
- string
- Description
Country name where the store is located
- Name
hdnCode- Type
- string
- Description
HDN code of the store
- Name
enableClickCollect- Type
- boolean
- Description
Flag to check if the Click collect option is enabled
Request
curl --location 'https://api20.bettercommerce.io/api/v2/stores/all'
Response
{
"statusCode": 414,
"status": "adipisicing mollit elit",
"errors": [
"consequat elit et eu",
"dolor"
],
"success": true,
"message": "in ut est",
"messageCode": "deserunt esse occaecat",
"result": [
{
"id": "in amet velit minim eiusmod",
"name": "anim sed aliquip",
"address1": "non ea dolor",
"address2": "veniam et Lorem",
"city": "dolor aute ex",
"state": "non",
"postCode": "enim officia Lorem Duis",
"yourId": "ame",
"distanceFromPostCode": 68195756.57360613,
"distanceUnit": "ut",
"shippingPlanId": "anim ut ipsum irure",
"type": "amet aliqua exercitation Duis",
"leadTimeUnit": "laboris in eiusmod proident nostrud",
"leadTimeMin": -89263541,
"leadTimeMax": -50046647,
"deliveryOption": "qui aliqua in laboris n",
"shippingAddressId": "nulla sunt ea dolor",
"openingHours": "eu in",
"slots": [
{
"slot": "non in voluptate",
"slotMessage": "eu nisi non id"
},
{
"slot": "consectetur ipsum dolor ut id",
"slotMessage": "adipisicing ad laboris est"
}
],
"whyDelayMsg1": "elit",
"whyDelayMsg2": "consequat mollit proident ex",
"whyDelayMsg3": "cillum sint ",
"selectedSlot": "Excepteur aute vol",
"phoneNo": "et mollit in do",
"timeslotActual": "elit officia adipisicing culpa id",
"latitude": "est ex",
"longitude": "ea mollit in in",
"image": "cillum aliquip ex tempor cupidatat",
"country": "eu in occaecat",
"hdnCode": "sunt non enim in",
"enableClickCollect": true
},
{
"id": "sed do elit",
"name": "dolor sint voluptate",
"address1": "est",
"address2": "aliqui",
"city": "amet sed velit cillum",
"state": "nisi",
"postCode": "labore mollit dolore",
"yourId": "aute consectetur consequat anim",
"distanceFromPostCode": -19444355.608761027,
"distanceUnit": "laboris sint cillum pariatur",
"shippingPlanId": "Ut sed reprehenderit",
"type": "et consequat labore",
"leadTimeUnit": "Ut dolore ipsum pariatur do",
"leadTimeMin": -42145051,
"leadTimeMax": 2825087,
"deliveryOption": "magna reprehenderit Excepteur qui",
"shippingAddressId": "esse elit consectetur tempor qui",
"openingHours": "minim dolore elit dolor",
"slots": [
{
"slot": "nulla dolore",
"slotMessage": "aute Ut"
},
{
"slot": "in sit",
"slotMessage": "sit aliquip tempor sed"
}
],
"whyDelayMsg1": "qui nostrud aliqua mollit",
"whyDelayMsg2": "magna Lorem id",
"whyDelayMsg3": "enim",
"selectedSlot": "labore deserunt",
"phoneNo": "mollit proident ea minim",
"timeslotActual": "nostrud in elit nisi",
"latitude": "cupidatat ea",
"longitude": "dolore nisi dolor dolore",
"image": "id",
"country": "in dolor ut",
"hdnCode": "aliqua commodo non sunt",
"enableClickCollect": false
}
]
}
Search store based on postcode
This endpoint allows you to Search store based on postcode.
Developers - API Operations:
| Operation | Endpoint | Response |
|---|---|---|
| Search Store | /api/v2/stores/:postCode | Search store based on postcode. |
Required attributes
- Name
postCode- Type
- string
- Description
Postal code of the Store
Response Properties
- Name
statusCode- Type
- number
- Description
Status code of the response
- Name
status- Type
- string
- Description
Status of the response
- Name
errors- Type
- array
- Description
List of errors in the response
- Name
success- Type
- boolean
- Description
Success status of the response
- Name
message- Type
- string
- Description
Message of the response
- Name
messageCode- Type
- string
- Description
Message code of the response
- Name
result- Type
- array
- Description
Result of the response
- Name
id- Type
- string
- Description
Id to identify the address
- Name
name- Type
- string
- Description
Name of the product
- Name
address1- Type
- string
- Description
Address Line 1 provided by the user
- Name
address2- Type
- Description
Address Line 2 provided by the user
- Name
city- Type
- string
- Description
City name provided by the user
- Name
state- Type
- string
- Description
State name provided by the user
- Name
postCode- Type
- string
- Description
Post code of the store
- Name
yourId- Type
- string
- Description
Id of the customer
- Name
distanceFromPostCode- Type
- string
- Description
Distance of the store from the Postal code
- Name
distanceUnit- Type
- string
- Description
Unit of the distance provided
- Name
shippingPlanId- Type
- string
- Description
Shipping plan Id used to identify the shipping plan
- Name
type- Type
- string
- Description
Type of stores for the order
- Name
leadTimeUnit- Type
- string
- Description
Unit of measurement for Lead time
- Name
leadTimeMin- Type
- number
- Description
The minimum lead time for the order to be delivered
- Name
leadTimeMax- Type
- number
- Description
The maximum lead time for the order to be delivered
- Name
deliveryOption- Type
- string
- Description
Delivery option selected bu the user
- Name
shippingAddressId- Type
- string
- Description
Shipping address Id used to identify the shipping address
- Name
openingHours- Type
- string
- Description
Opening hours of the store
- Name
slots- Type
- array
- Description
List of slots available at the store
- Name
slot- Type
- string
- Description
Available slot of the store
- Name
slotMessage- Type
- string
- Description
Message for the available slot of the store
- Name
whyDelayMsg1- Type
- string
- Description
Message stating the reason for delay
- Name
whyDelayMsg2- Type
- string
- Description
Message stating the reason for delay
- Name
whyDelayMsg3- Type
- string
- Description
Message stating the reason for delay
- Name
selectedSlot- Type
- string
- Description
Slot selected by the user
- Name
phoneNo- Type
- string
- Description
Phone number of the store
- Name
timeslotActual- Type
- string
- Description
Actual time slot of the store
- Name
latitude- Type
- string
- Description
Latitude of the geographical location of the store
- Name
longitude- Type
- string
- Description
Longitude of the geographical location of the store
- Name
image- Type
- string
- Description
File name/URL of the image of the store
- Name
country- Type
- string
- Description
Country name where the store is located
- Name
hdnCode- Type
- string
- Description
HDN code of the store
- Name
enableClickCollect- Type
- boolean
- Description
Flag to check if the Click collect option is enabled
Request
curl --location --request POST 'https://api20.bettercommerce.io/api/v2/stores/proident culpa anim nisi aliquip'
Response
{
"statusCode": 414,
"status": "adipisicing mollit elit",
"errors": [
"consequat elit et eu",
"dolor"
],
"success": true,
"message": "in ut est",
"messageCode": "deserunt esse occaecat",
"result": [
{
"id": "in amet velit minim eiusmod",
"name": "anim sed aliquip",
"address1": "non ea dolor",
"address2": "veniam et Lorem",
"city": "dolor aute ex",
"state": "non",
"postCode": "enim officia Lorem Duis",
"yourId": "ame",
"distanceFromPostCode": 68195756.57360613,
"distanceUnit": "ut",
"shippingPlanId": "anim ut ipsum irure",
"type": "amet aliqua exercitation Duis",
"leadTimeUnit": "laboris in eiusmod proident nostrud",
"leadTimeMin": -89263541,
"leadTimeMax": -50046647,
"deliveryOption": "qui aliqua in laboris n",
"shippingAddressId": "nulla sunt ea dolor",
"openingHours": "eu in",
"slots": [
{
"slot": "non in voluptate",
"slotMessage": "eu nisi non id"
},
{
"slot": "consectetur ipsum dolor ut id",
"slotMessage": "adipisicing ad laboris est"
}
],
"whyDelayMsg1": "elit",
"whyDelayMsg2": "consequat mollit proident ex",
"whyDelayMsg3": "cillum sint ",
"selectedSlot": "Excepteur aute vol",
"phoneNo": "et mollit in do",
"timeslotActual": "elit officia adipisicing culpa id",
"latitude": "est ex",
"longitude": "ea mollit in in",
"image": "cillum aliquip ex tempor cupidatat",
"country": "eu in occaecat",
"hdnCode": "sunt non enim in",
"enableClickCollect": true
},
{
"id": "sed do elit",
"name": "dolor sint voluptate",
"address1": "est",
"address2": "aliqui",
"city": "amet sed velit cillum",
"state": "nisi",
"postCode": "labore mollit dolore",
"yourId": "aute consectetur consequat anim",
"distanceFromPostCode": -19444355.608761027,
"distanceUnit": "laboris sint cillum pariatur",
"shippingPlanId": "Ut sed reprehenderit",
"type": "et consequat labore",
"leadTimeUnit": "Ut dolore ipsum pariatur do",
"leadTimeMin": -42145051,
"leadTimeMax": 2825087,
"deliveryOption": "magna reprehenderit Excepteur qui",
"shippingAddressId": "esse elit consectetur tempor qui",
"openingHours": "minim dolore elit dolor",
"slots": [
{
"slot": "nulla dolore",
"slotMessage": "aute Ut"
},
{
"slot": "in sit",
"slotMessage": "sit aliquip tempor sed"
}
],
"whyDelayMsg1": "qui nostrud aliqua mollit",
"whyDelayMsg2": "magna Lorem id",
"whyDelayMsg3": "enim",
"selectedSlot": "labore deserunt",
"phoneNo": "mollit proident ea minim",
"timeslotActual": "nostrud in elit nisi",
"latitude": "cupidatat ea",
"longitude": "dolore nisi dolor dolore",
"image": "id",
"country": "in dolor ut",
"hdnCode": "aliqua commodo non sunt",
"enableClickCollect": false
}
]
}