Big Commerce Get Locations
Summary of Changes: (The purpose of this table is to keep traceability and Product team to highlight the things that were changed into the scope, based on comments or discussions)
Date | Version | Name | Applied changes |
---|---|---|---|
09/08/2023 | 1.0 | Bogomil Pavlov | First Publish |
21/11/2023 | v1.1 | Bogomil Pavlov | Keep the location per account id |
We want to get all available location from Big Commerce and store them as enumeration field. The field should be available In Account Big Commerce.
API Call: GET https://api.bigcommerce.com/stores/{store_hash}/v3/inventory/locations
Sample Request: GET https://api.bigcommerce.com/stores/oduzegjfvn/v3/inventory/locations
Sample Response: Status 200 OK
{
"data": [
{
"id": 1,
"code": "BC-LOCATION-1",
"label": "Default location",
"description": null,
"managed_by_external_source": false,
"type_id": "PHYSICAL",
"enabled": true,
"operating_hours": null,
"time_zone": null,
"created_at": "2023-07-30T20:30:39Z",
"updated_at": "2023-07-30T20:30:39Z",
"address": {
"address1": "Goriubliane",
"address2": "Grodno 10",
"city": "Sofia",
"state": "",
"zip": "1000",
"phone": "0896352803",
"geo_coordinates": {
"latitude": null,
"longitude": null
},
"country_code": "BG"
},
"storefront_visibility": true,
"special_hours": []
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 1000,
"current_page": 1,
"total_pages": 1,
"links": {
"previous": "?limit=1000&page=1",
"current": "?limit=1000&page=1",
"next": "?limit=1000&page=1"
}
}
}
}
Mapping:
Big Commerce Field | Hemi Field | Comment |
---|---|---|
id |
Big Commerce Location > Warehouse Id | We want to store the ID and display the label |
label |
Big Commerce Location > Warehouse Name | We want to store the ID and display the label |
<v1.1>Please note since we can have more than one BigCommerce integration on a single instance we want to also the store the account id against each location id which will allow is to display in the UI only the relevant location ids for the account</v1.1>