Download OpenAPI specification:Download
Copilot Business Layer
Get Inventory
object |
Get List of Inventories success
A generic client error
A generic Unauthorized Error
A generic Items Not Found Error
A generic server error
{- "query": {
- "offset": 0,
- "limit": 10,
- "count": 1000
}, - "data": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "title": "Shirt",
- "sku": "SHIRT001",
- "itemId": 1000000033,
- "group": [
- {
- "videos": [
- {
- "label": "string",
- "order": 0,
- "url": "string",
- "provider": "string",
- "thumbnails": [
- { }
]
}
], - "_id": "5fee9d59f2f08a1b3cbdea08",
- "channel": [ ],
- "isInternal": true,
- "isActive": true,
- "isSoftDeleted": true,
- "name": "Western",
- "kind": "CATEGORY",
- "parent": "5fe32901819ad50007d899eb",
- "groupId": 6,
- "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- null
]
}
]
}
], - "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
}
]
}
], - "inventory": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "title": "Shirt",
- "sku": "SHIRT001",
- "itemId": 1000000033,
- "inlocations": [
- {
- "inTransit": [
- {
- "_id": null,
- "id": null,
- "inTransitRef": null,
- "orderQuantity": null,
- "quantityReserved": null,
- "orderDate": null,
- "stockDate": null
}
], - "location": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- null
], - "address": {
- "street1": null,
- "street2": null,
- "city": null,
- "state": null,
- "country": null,
- "zipCode": null,
- "phone": [ ]
}, - "isActive": false,
- "isDefault": false,
- "name": "New785",
- "pickup": false,
- "type": "60a5844e52e07600089d2cb8",
- "kind": "Warehouse",
- "locationId": 106,
- "coordinates": {
- "latitude": null,
- "longitude": null
}
}, - "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "inStock": 10,
- "channel": [
- {
- "_id": null,
- "id": null,
- "quantityReserved": null,
- "channelId": null,
- "allocation": { }
}
]
}
]
}, - "itemFamily": "5fe444d019956d0007ad0d42"
}
]
}
Get Inventory SKU List
Get SKU List Successfuly
A generic client error
A generic Unauthorized Error
A generic server error
[- {
- "group": [
- {
- "videos": [
- {
- "label": "string",
- "order": 0,
- "url": "string",
- "provider": "string",
- "thumbnails": [
- {
- "size": null,
- "url": null
}
]
}
], - "_id": "5fee9d59f2f08a1b3cbdea08",
- "channel": [ ],
- "isInternal": true,
- "isActive": true,
- "isSoftDeleted": true,
- "name": "Western",
- "kind": "CATEGORY",
- "parent": "5fe32901819ad50007d899eb",
- "groupId": 6,
- "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- {
- "_id": null,
- "id": null,
- "url": null
}
]
}
]
}
], - "_id": "5fee9d59f2f08a1b3cbdea08",
- "title": "Shirt",
- "sku": "SHIRT001",
- "itemId": 1000000033
}
]
Get all inventory for item Ids
Get all inventory for item Ids Successfuly
A generic client error
A generic Unauthorized Error
A generic Items Not Found Error
A generic server error
{- "offset": 0,
- "limit": 10,
- "itemIds": [
- 1000000214,
- 1000000216
]
}
[- {
- "inventory": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "title": "Shirt",
- "sku": "SHIRT001",
- "itemId": 1000000033,
- "inlocations": [
- {
- "inTransit": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "inTransitRef": "WO-20000",
- "orderQuantity": 1000,
- "quantityReserved": 0,
- "orderDate": "2020-05-05T00:00:00.000Z",
- "stockDate": "2020-05-05T00:00:00.000Z"
}
], - "location": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12
], - "address": {
- "street1": "5608 17th Avenue NW",
- "street2": "suite 219",
- "city": "Seattle",
- "state": "WA",
- "country": "United States",
- "zipCode": "98107",
- "phone": [ ]
}, - "isActive": false,
- "isDefault": false,
- "name": "New785",
- "pickup": false,
- "type": "60a5844e52e07600089d2cb8",
- "kind": "Warehouse",
- "locationId": 106,
- "coordinates": {
- "latitude": 47.669702,
- "longitude": -122.378762
}
}, - "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "inStock": 10,
- "channel": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "quantityReserved": 4,
- "channelId": 12,
- "allocation": {
- "mou": null,
- "unit": null
}
}
]
}
]
}, - "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12
], - "attributes": [
- {
- "attributeGroupName": "string",
- "name": "Weight",
- "value": 3,
- "isDefault": false,
- "display": false,
- "uom": "kg",
- "datatype": "UOM"
}
], - "group": [
- {
- "videos": [
- {
- "label": "string",
- "order": 0,
- "url": "string",
- "provider": "string",
- "thumbnails": [
- {
- "size": null,
- "url": null
}
]
}
], - "_id": "5fee9d59f2f08a1b3cbdea08",
- "channel": [ ],
- "isInternal": true,
- "isActive": true,
- "isSoftDeleted": true,
- "name": "Western",
- "kind": "CATEGORY",
- "parent": "5fe32901819ad50007d899eb",
- "groupId": 6,
- "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- {
- "_id": null,
- "id": null,
- "url": null
}
]
}
]
}
], - "title": "Shirt",
- "sku": "SHIRT001",
- "itemId": 1000000033,
- "variants": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "attributeGroupId": "string",
- "value": "string",
- "isDefault": true,
- "image": {
- "label": "string",
- "url": "string"
}
}
], - "videos": [
- {
- "label": "string",
- "order": 0,
- "url": "string",
- "provider": "string",
- "thumbnails": [
- {
- "size": "string",
- "url": "string"
}
]
}
], - "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
}
]
}
], - "startDate": "2020-12-31T13:18:46.111Z",
- "endDate": "2020-12-31T13:18:46.111Z",
- "isActive": true,
- "isSoftDeleted": true,
- "isDefault": true,
- "itemFamily": "5fe444d019956d0007ad0d42",
- "category": "string",
- "skuInSet": [ ],
- "state": "READY",
- "description": "Sample Description",
- "imagesSetOnAttributes": [ ]
}
]
Get Inventory by Query
Get Inventories based on query
A generic client error
A generic Unauthorized Error
A generic Items Not Found Error
A generic server error
{- "offset": 0,
- "limit": 10,
- "itemIds": [
- 1000000214,
- 1000000216
], - "queryType": "paginated"
}
{- "itemId": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12
], - "attributes": [
- {
- "attributeGroupName": "string",
- "name": "Weight",
- "value": 3,
- "isDefault": false,
- "display": false,
- "uom": "kg",
- "datatype": "UOM"
}
], - "group": [
- {
- "videos": [
- {
- "label": "string",
- "order": 0,
- "url": "string",
- "provider": "string",
- "thumbnails": [
- { }
]
}
], - "_id": "5fee9d59f2f08a1b3cbdea08",
- "channel": [ ],
- "isInternal": true,
- "isActive": true,
- "isSoftDeleted": true,
- "name": "Western",
- "kind": "CATEGORY",
- "parent": "5fe32901819ad50007d899eb",
- "groupId": 6,
- "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- null
]
}
]
}
], - "title": "Shirt",
- "sku": "SHIRT001",
- "itemId": 1000000033,
- "variants": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "attributeGroupId": "string",
- "value": "string",
- "isDefault": true,
- "image": {
- "label": "string",
- "url": "string"
}
}
], - "videos": [
- {
- "label": "string",
- "order": 0,
- "url": "string",
- "provider": "string",
- "thumbnails": [
- {
- "size": "string",
- "url": "string"
}
]
}
], - "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
}
]
}
], - "startDate": "2020-12-31T13:18:46.111Z",
- "endDate": "2020-12-31T13:18:46.111Z",
- "isActive": true,
- "isSoftDeleted": true,
- "isDefault": true,
- "itemFamily": "5fe444d019956d0007ad0d42",
- "category": "string",
- "skuInSet": [ ],
- "state": "READY",
- "description": "Sample Description",
- "imagesSetOnAttributes": [ ]
}
], - "sku": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12
], - "attributes": [
- {
- "attributeGroupName": "string",
- "name": "Weight",
- "value": 3,
- "isDefault": false,
- "display": false,
- "uom": "kg",
- "datatype": "UOM"
}
], - "group": [
- {
- "videos": [
- {
- "label": "string",
- "order": 0,
- "url": "string",
- "provider": "string",
- "thumbnails": [
- { }
]
}
], - "_id": "5fee9d59f2f08a1b3cbdea08",
- "channel": [ ],
- "isInternal": true,
- "isActive": true,
- "isSoftDeleted": true,
- "name": "Western",
- "kind": "CATEGORY",
- "parent": "5fe32901819ad50007d899eb",
- "groupId": 6,
- "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- null
]
}
]
}
], - "title": "Shirt",
- "sku": "SHIRT001",
- "itemId": 1000000033,
- "variants": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "attributeGroupId": "string",
- "value": "string",
- "isDefault": true,
- "image": {
- "label": "string",
- "url": "string"
}
}
], - "videos": [
- {
- "label": "string",
- "order": 0,
- "url": "string",
- "provider": "string",
- "thumbnails": [
- {
- "size": "string",
- "url": "string"
}
]
}
], - "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
}
]
}
], - "startDate": "2020-12-31T13:18:46.111Z",
- "endDate": "2020-12-31T13:18:46.111Z",
- "isActive": true,
- "isSoftDeleted": true,
- "isDefault": true,
- "itemFamily": "5fe444d019956d0007ad0d42",
- "category": "string",
- "skuInSet": [ ],
- "state": "READY",
- "description": "Sample Description",
- "imagesSetOnAttributes": [ ]
}
], - "title": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12
], - "attributes": [
- {
- "attributeGroupName": "string",
- "name": "Weight",
- "value": 3,
- "isDefault": false,
- "display": false,
- "uom": "kg",
- "datatype": "UOM"
}
], - "group": [
- {
- "videos": [
- {
- "label": "string",
- "order": 0,
- "url": "string",
- "provider": "string",
- "thumbnails": [
- { }
]
}
], - "_id": "5fee9d59f2f08a1b3cbdea08",
- "channel": [ ],
- "isInternal": true,
- "isActive": true,
- "isSoftDeleted": true,
- "name": "Western",
- "kind": "CATEGORY",
- "parent": "5fe32901819ad50007d899eb",
- "groupId": 6,
- "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- null
]
}
]
}
], - "title": "Shirt",
- "sku": "SHIRT001",
- "itemId": 1000000033,
- "variants": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "attributeGroupId": "string",
- "value": "string",
- "isDefault": true,
- "image": {
- "label": "string",
- "url": "string"
}
}
], - "videos": [
- {
- "label": "string",
- "order": 0,
- "url": "string",
- "provider": "string",
- "thumbnails": [
- {
- "size": "string",
- "url": "string"
}
]
}
], - "images": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
- "order": 0,
- "label": "Test",
- "source": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "id": "5fee9d59f2f08a1b3cbdea08",
}
]
}
], - "startDate": "2020-12-31T13:18:46.111Z",
- "endDate": "2020-12-31T13:18:46.111Z",
- "isActive": true,
- "isSoftDeleted": true,
- "isDefault": true,
- "itemFamily": "5fe444d019956d0007ad0d42",
- "category": "string",
- "skuInSet": [ ],
- "state": "READY",
- "description": "Sample Description",
- "imagesSetOnAttributes": [ ]
}
]
}
Get URL to upload file to S3
Uploaded Successfully
A generic client error
A generic Unauthorized Error
A generic server error
{- "fileName": "template.csv",
- "type": "inventory"
}
{- "fileName": "inventory_0301.csv",
- "type": "inventory"
}
Get all Statuses
All Statuses
A generic client error
A generic Unauthorized Error
A generic server error
{- "query": {
- "offset": 0,
- "limit": 10,
- "count": 1000
}, - "uploadHistory": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "itemFamily": "5fe444d019956d0007ad0d42",
- "keyId": "api-1618948218654",
- "type": "api",
- "status": "FINISHED",
- "totalItems": 1,
- "totalItemsUploaded": 1,
- "totalRows": 2,
- "totalRowsErrors": 0,
- "messages": [
- "Import Inventory job started: Tue Apr 20 2021 19:50:18 GMT+0000 (Coordinated Universal Time)",
- "2 row(s) found",
- "1 Inventory Item(s) found",
- "Successfully saved 1 items ",
- "Successfully finished API Inventory Bulk Upload: Tue Apr 20 2021 19:50:19 GMT+0000 (Coordinated Universal Time)"
]
}
]
}
{- "itemIds": [
- 1000000214,
- 1000000216
], - "eventSource": "cpmmerce",
- "accountId": "8739392294",
- "stage": "dev02"
}
"Event source must be from commerce"
Get Bulk upload status by Key Id
Get Bulk upload status by Key Id
A generic client error
A generic Unauthorized Error
A generic server error
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "itemFamily": "5fe444d019956d0007ad0d42",
- "keyId": "api-1618948218654",
- "type": "api",
- "status": "FINISHED",
- "totalItems": 1,
- "totalItemsUploaded": 1,
- "totalRows": 2,
- "totalRowsErrors": 0,
- "messages": [
- "Import Inventory job started: Tue Apr 20 2021 19:50:18 GMT+0000 (Coordinated Universal Time)",
- "2 row(s) found",
- "1 Inventory Item(s) found",
- "Successfully saved 1 items ",
- "Successfully finished API Inventory Bulk Upload: Tue Apr 20 2021 19:50:19 GMT+0000 (Coordinated Universal Time)"
]
}
Bulk Insert Inventory
Bulk Insert Inventories
A generic client error
A generic Unauthorized Error
A generic server error
[- {
- "sku": "1597422",
- "itemId": 1597422,
- "totalQuantity": 25,
- "reservedQuantity": 0,
- "locationId": 175,
- "type": "Stock",
- "channelId": 12,
- "transitRef": "wo-2002",
- "transitOrderDate": "2019-12-14",
- "transitStockDate": "2019-12-14"
}
]
[- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "itemFamily": "5fe444d019956d0007ad0d42",
- "keyId": "api-1618948218654",
- "type": "api",
- "status": "FINISHED",
- "totalItems": 1,
- "totalItemsUploaded": 1,
- "totalRows": 2,
- "totalRowsErrors": 0,
- "messages": [
- "Import Inventory job started: Tue Apr 20 2021 19:50:18 GMT+0000 (Coordinated Universal Time)",
- "2 row(s) found",
- "1 Inventory Item(s) found",
- "Successfully saved 1 items ",
- "Successfully finished API Inventory Bulk Upload: Tue Apr 20 2021 19:50:19 GMT+0000 (Coordinated Universal Time)"
]
}
]
Get Warehouse
object |
Get List Of Warehouses
A generic client error
A generic Unauthorized Error
A generic server error
{- "query": {
- "offset": 0,
- "limit": 10,
- "count": 1000
}, - "locations": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12,
- 13
], - "type": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Test -12345",
- "priority": 60
}, - "isActive": true,
- "isDefault": true,
- "pickup": true,
- "name": "Warehouse name 104",
- "kind": "Warehouse",
- "shortName": "string",
- "address": {
- "attention": "string",
- "street1": "5608 17th Avenue NW",
- "street2": "suite 219",
- "city": "Seattle",
- "state": "WA",
- "country": "United States",
- "zipCode": "98107",
- "email": "string",
- "phone": [
- {
- "number": "17146541403",
- "kind": "mobile"
}
], - "kind": "string"
}, - "locationId": 161,
- "coordinates": {
- "latitude": 47.669702,
- "longitude": -122.378762
}
}
], - "status": {
- "totalWarehouses": 10,
- "channels": [
- {
- "channelId": 11,
- "active": 1,
- "isActive": 1,
- "total": 7
}
]
}
}
Create Warehouse
Successfully Created Warehouse
A generic client error
A generic Unauthorized Error
A generic server error
{- "channel": [
- 12,
- 13
], - "isActive": true,
- "isDefault": true,
- "pickup": true,
- "name": "Warehouse name 104",
- "kind": "Warehouse",
- "address": {
- "attention": "string",
- "street1": "5608 17th Avenue NW",
- "street2": "suite 219",
- "city": "Seattle",
- "state": "WA",
- "country": "United States",
- "zipCode": "98107",
- "email": "string",
- "phone": [
- {
- "number": "17146541403",
- "kind": "mobile"
}
], - "kind": "string"
}, - "shortName": "TAG-ABC123",
- "type": "stringstringstringstring"
}
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12,
- 13
], - "type": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Test -12345",
- "priority": 60
}, - "isActive": true,
- "isDefault": true,
- "pickup": true,
- "name": "Warehouse name 104",
- "kind": "Warehouse",
- "shortName": "string",
- "address": {
- "attention": "string",
- "street1": "5608 17th Avenue NW",
- "street2": "suite 219",
- "city": "Seattle",
- "state": "WA",
- "country": "United States",
- "zipCode": "98107",
- "email": "string",
- "phone": [
- {
- "number": "17146541403",
- "kind": "mobile"
}
], - "kind": "string"
}, - "locationId": 161,
- "coordinates": {
- "latitude": 47.669702,
- "longitude": -122.378762
}
}
Get Warehouse by Query
Get List Of inventory based on a query
A generic client error
A generic Unauthorized Error
Location Not Found Error
A generic server error
{- "offset": 0,
- "limit": 10,
- "queryType": "paginated",
- "warehouseId": 1000000608,
- "searchTerm": "Warehouse"
}
{- "locationId": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12,
- 13
], - "type": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Test -12345",
- "priority": 60
}, - "isActive": true,
- "isDefault": true,
- "pickup": true,
- "name": "Warehouse name 104",
- "kind": "Warehouse",
- "shortName": "string",
- "address": {
- "attention": "string",
- "street1": "5608 17th Avenue NW",
- "street2": "suite 219",
- "city": "Seattle",
- "state": "WA",
- "country": "United States",
- "zipCode": "98107",
- "email": "string",
- "phone": [
- {
- "number": "17146541403",
- "kind": "mobile"
}
], - "kind": "string"
}, - "locationId": 161,
- "coordinates": {
- "latitude": 47.669702,
- "longitude": -122.378762
}
}
], - "name": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12,
- 13
], - "type": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Test -12345",
- "priority": 60
}, - "isActive": true,
- "isDefault": true,
- "pickup": true,
- "name": "Warehouse name 104",
- "kind": "Warehouse",
- "shortName": "string",
- "address": {
- "attention": "string",
- "street1": "5608 17th Avenue NW",
- "street2": "suite 219",
- "city": "Seattle",
- "state": "WA",
- "country": "United States",
- "zipCode": "98107",
- "email": "string",
- "phone": [
- {
- "number": "17146541403",
- "kind": "mobile"
}
], - "kind": "string"
}, - "locationId": 161,
- "coordinates": {
- "latitude": 47.669702,
- "longitude": -122.378762
}
}
], - "channel": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12,
- 13
], - "type": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Test -12345",
- "priority": 60
}, - "isActive": true,
- "isDefault": true,
- "pickup": true,
- "name": "Warehouse name 104",
- "kind": "Warehouse",
- "shortName": "string",
- "address": {
- "attention": "string",
- "street1": "5608 17th Avenue NW",
- "street2": "suite 219",
- "city": "Seattle",
- "state": "WA",
- "country": "United States",
- "zipCode": "98107",
- "email": "string",
- "phone": [
- {
- "number": "17146541403",
- "kind": "mobile"
}
], - "kind": "string"
}, - "locationId": 161,
- "coordinates": {
- "latitude": 47.669702,
- "longitude": -122.378762
}
}
]
}
Get Warehouse By Id
Successfully Return Warehouse
A generic client error
A generic Unauthorized Error
Location Not Found Error
A generic server error
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12,
- 13
], - "type": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Test -12345",
- "priority": 60
}, - "isActive": true,
- "isDefault": true,
- "pickup": true,
- "name": "Warehouse name 104",
- "kind": "Warehouse",
- "shortName": "string",
- "address": {
- "attention": "string",
- "street1": "5608 17th Avenue NW",
- "street2": "suite 219",
- "city": "Seattle",
- "state": "WA",
- "country": "United States",
- "zipCode": "98107",
- "email": "string",
- "phone": [
- {
- "number": "17146541403",
- "kind": "mobile"
}
], - "kind": "string"
}, - "locationId": 161,
- "coordinates": {
- "latitude": 47.669702,
- "longitude": -122.378762
}
}
Update Warehouse
Successfully Updated Warehouse
A generic client error
A generic Unauthorized Error
Location Not Found Error
A generic server error
{- "channel": [
- 12,
- 13
], - "isActive": true,
- "isDefault": true,
- "pickup": true,
- "name": "Warehouse name 104",
- "kind": "Warehouse",
- "address": {
- "attention": "string",
- "street1": "5608 17th Avenue NW",
- "street2": "suite 219",
- "city": "Seattle",
- "state": "WA",
- "country": "United States",
- "zipCode": "98107",
- "email": "string",
- "phone": [
- {
- "number": "17146541403",
- "kind": "mobile"
}
], - "kind": "string"
}, - "shortName": "TAG-ABC123",
- "type": "stringstringstringstring"
}
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "channel": [
- 12,
- 13
], - "type": {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Test -12345",
- "priority": 60
}, - "isActive": true,
- "isDefault": true,
- "pickup": true,
- "name": "Warehouse name 104",
- "kind": "Warehouse",
- "shortName": "string",
- "address": {
- "attention": "string",
- "street1": "5608 17th Avenue NW",
- "street2": "suite 219",
- "city": "Seattle",
- "state": "WA",
- "country": "United States",
- "zipCode": "98107",
- "email": "string",
- "phone": [
- {
- "number": "17146541403",
- "kind": "mobile"
}
], - "kind": "string"
}, - "locationId": 161,
- "coordinates": {
- "latitude": 47.669702,
- "longitude": -122.378762
}
}
Get list of all available channels
Get List of channels
A generic client error
A generic Unauthorized Error
A generic server error
[- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "CA Web",
- "channelCode": "CAN",
- "kind": "Regional",
- "region": "5da98b46f20a420a5a6c8900",
- "channelId": 12,
- "isActive": true,
- "address": [ ]
}
]
Get channels status
required | Array of objects |
Get List of channels Statuses
A generic client error
A generic Unauthorized Error
A generic server error
{- "channels": [
- {
- "label": "Channel 11",
- "value": 11
}
]
}
{- "channelsStatus": [
- {
- "channelId": 11,
- "active": 1,
- "isActive": 1,
- "total": 7
}
]
}
Get All Fulfillment Methods
Get All Fulfilment Methods
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
[- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Bellevue Warehouse Main",
- "priority": 65
}
]
Create a Fulfillment Method
Successfully Created Fulfilment Method
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "name": "Bellevue Warehouse Main"
}
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Bellevue Warehouse Main",
- "priority": 65
}
Get Fulfillment Method by Id
Get Fulfilment Method By ID
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
Fulfilment Method Not Found Error
A generic server error
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Bellevue Warehouse Main",
- "priority": 65
}
Update Fulfillment Method by Id
Update Fulfilment Method By ID
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
Fulfilment Method Not Found Error
A generic server error
{- "name": "Bellevue Warehouse Main"
}
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Bellevue Warehouse Main",
- "priority": 65
}
Set Priority
required | Array of objects |
Successfully Set Priority
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "method": [
- {
- "methodId": "5e4b0a8cef94d00b11acc382",
- "priority": 50
}
]
}
{- "message": "Priority Updated Successfully",
- "warnings": [
- "This Fulfillment ID :607f0b0cacc3d0000816203e does not exist"
]
}
Create New Attribute
Successfully Created Attribute
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "name": "Gift Messaging",
- "level": "order",
- "price": 50.25,
- "type": "bool",
- "isDeleted": false,
- "items": [
- [
- "1000083",
- "1000084"
]
]
}
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Gift Messaging",
- "level": "order",
- "price": 50.25,
- "type": "bool",
- "isDeleted": false,
- "items": [
- [
- "1000083",
- "1000084"
]
]
}
Get Attribute
Get Attribute
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
Object with the sent attribute Id is not found
A generic server error
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Gift Messaging",
- "level": "order",
- "price": 50.25,
- "type": "bool",
- "isDeleted": false,
- "items": [
- [
- "1000083",
- "1000084"
]
]
}
Update Attribute
Successfully Updated Attribute
Object with the sent attribute Id is not found
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "name": "Gift Messaging",
- "level": "order",
- "price": 50.25,
- "type": "bool",
- "items": [
- [
- "1000083",
- "1000084"
]
]
}
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Gift Messaging",
- "level": "order",
- "price": 50.25,
- "type": "bool",
- "isDeleted": false,
- "items": [
- [
- "1000083",
- "1000084"
]
]
}
Delete Attribute
Successfully Deleted Attribute
Object with the sent attribute Id is not found or it is already deleted
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Gift Messaging",
- "level": "order",
- "price": 50.25,
- "type": "bool",
- "isDeleted": false,
- "items": [
- [
- "1000083",
- "1000084"
]
]
}
Get All Attributes
Attributes response
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "query": {
- "offset": 0,
- "limit": 10,
- "count": 1000
}, - "attributes": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "name": "Gift Messaging",
- "price": 50.25,
- "type": "bool"
}
]
}
Restore Deleted Attribute
Restore Deleted Attribute
Object with the sent attribute Id is not found or it is already restored
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Gift Messaging",
- "level": "order",
- "price": 50.25,
- "type": "bool",
- "isDeleted": false,
- "items": [
- [
- "1000083",
- "1000084"
]
]
}
Get Deleted attribute from attributeId
Get Deleted Attribute
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
Object with the sent attribute Id is not found
A generic server error
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "name": "Gift Messaging",
- "level": "order",
- "price": 50.25,
- "type": "bool",
- "isDeleted": false,
- "items": [
- [
- "1000083",
- "1000084"
]
]
}
Get All Order level Attributes
Get Order Level Attributes
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "attributes": [
- {
- "_id": "5fee9d59f2f08a1b3cbdea08",
- "name": "Gift Messaging",
- "price": 50.25,
- "type": "bool"
}
]
}
Create or Update Store Settings
Create Or Update Setting
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "fulfillmentSetting": "distance"
}
{- "_id": "5fee9d59f2f08a1b3cbdea08",
- "createdAt": "2020-12-31T02:09:53.914Z",
- "updatedAt": "2020-12-31T02:09:53.914Z",
- "cancellationPolicy": {
- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}, - "returnPolicy": {
- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}, - "sugarRefundPolicy": {
- "maxOrderValue": 1000,
- "isEnabled": true,
- "totalRefundsAllowed": 12,
- "currency": "USD"
}, - "account": "5f689caa4216e7000750d1ef",
- "fulfillmentSetting": "distance"
}
Get Cancellation Policy
Get Cancellation Policy Successfully
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
Cancellation policy not found
A generic server error
{- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}
Create Cancellation Policy
Create Cancellation Policy Successfully
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}
{- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}
Update Cancellation Policy
Update Cancellation Policy Successfully
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}
{- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}
Get Return Policy
Get Cancellation Policy Successfully
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
Return policy not found
A generic server error
{- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}
Create Return Policy
Create Return Policy Successfully
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}
{- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}
Update Return Policy
Update Return Policy Successfully
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}
{- "autoRefund": true,
- "isEnabled": true,
- "windowHours": 12,
- "statuses": [
- "ORDER_CREATED"
]
}
Get Sugar Refund Policy
Get Sugar Refund Policy Successfully
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "maxOrderValue": 1000,
- "isEnabled": true,
- "totalRefundsAllowed": 12,
- "currency": "USD"
}
Create Sugar Refund Policy
Create Sugar Refund Policy Successfully
A generic client error
A generic Unauthorized Error
A generic Forbidden Error
A generic server error
{- "maxOrderValue": 1000,
- "isEnabled": true,
- "totalRefundsAllowed": 12,
- "currency": "USD"
}