Copilot Business Layer (1.0.0)

Download OpenAPI specification:Download

E-mail: oms-team@fabric.inc License: Fabric Inc

Copilot Business Layer

Inventory

Inventory APIs

Get Inventory

Request

query Parameters

object

Responses

200

Get List of Inventories success

400

A generic client error

401

A generic Unauthorized Error

404

A generic Items Not Found Error

500

A generic server error

get/inventory

Response samples

200
400
401
404
500

application/json

{"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",
"url": "https://assets.myntassets.com/h_1440,q_90,w_1080/v1/assets/images/2127877/2020/1/23/cdec6a27-4119-4401-9701-723c55130db11579772014115-Roadster-Men-White-Regular-Fit-Solid-Casual-Shirt-5771579772-1.jpg"
}
]
}
],
"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

Responses

200

Get SKU List Successfuly

400

A generic client error

401

A generic Unauthorized Error

500

A generic server error

get/inventory/sku-list

Response samples

200
400
401
500

application/json

[{"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 Inventory by Ids

Get all inventory for item Ids

Request

Request Body schema: application/json

offset	integer Default: 0
limit	integer Default: 10
itemIds required	Array of integers

Responses

200

Get all inventory for item Ids Successfuly

400

A generic client error

401

A generic Unauthorized Error

404

A generic Items Not Found Error

500

A generic server error

post/inventory/item-ids

Request samples

Payload

application/json

{"offset": 0,
"limit": 10,
"itemIds": [1000000214,
1000000216
]
}

Response samples

200
400
401
404
500

application/json

[{"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",
"url": "https://assets.myntassets.com/h_1440,q_90,w_1080/v1/assets/images/2127877/2020/1/23/cdec6a27-4119-4401-9701-723c55130db11579772014115-Roadster-Men-White-Regular-Fit-Solid-Casual-Shirt-5771579772-1.jpg"
}
]
}
],
"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

Request

Request Body schema: application/json

offset	integer Default: 0
limit	integer Default: 10
itemIds	Array of integers
queryType	string Default: "paginated" Enum: "paginated" "suggested"

Responses

200

Get Inventories based on query

400

A generic client error

401

A generic Unauthorized Error

404

A generic Items Not Found Error

500

A generic server error

post/inventory/query

Request samples

Payload

application/json

{"offset": 0,
"limit": 10,
"itemIds": [1000000214,
1000000216
],
"queryType": "paginated"
}

Response samples

200
400
401
404
500

application/json

{"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",
"url": "https://assets.myntassets.com/h_1440,q_90,w_1080/v1/assets/images/2127877/2020/1/23/cdec6a27-4119-4401-9701-723c55130db11579772014115-Roadster-Men-White-Regular-Fit-Solid-Casual-Shirt-5771579772-1.jpg"
}
]
}
],
"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",
"url": "https://assets.myntassets.com/h_1440,q_90,w_1080/v1/assets/images/2127877/2020/1/23/cdec6a27-4119-4401-9701-723c55130db11579772014115-Roadster-Men-White-Regular-Fit-Solid-Casual-Shirt-5771579772-1.jpg"
}
]
}
],
"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",
"url": "https://assets.myntassets.com/h_1440,q_90,w_1080/v1/assets/images/2127877/2020/1/23/cdec6a27-4119-4401-9701-723c55130db11579772014115-Roadster-Men-White-Regular-Fit-Solid-Casual-Shirt-5771579772-1.jpg"
}
]
}
],
"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

Request

Request Body schema: application/json

fileName required	string
type required	string Value: "inventory"

Responses

200

Uploaded Successfully

400

A generic client error

401

A generic Unauthorized Error

500

A generic server error

post/inventory/upload-url

Request samples

Payload

application/json

{"fileName": "template.csv",
"type": "inventory"
}

Response samples

200
400
401
500

application/json

{"fileName": "inventory_0301.csv",
"type": "inventory"
}

Get all Statuses

Responses

200

All Statuses

400

A generic client error

401

A generic Unauthorized Error

500

A generic server error

get/inventory/bulk-upload-status

Response samples

200
400
401
500

application/json

{"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)"
]
}
]
}

Inventory Change Sync

Request

Request Body schema: application/json

itemIds	Array of integers
eventSource	string Value: "commerce"
accountId	string
stage	string

Responses

200

Success

500

A generic server error

post/inventory/commerce-change-sync

Request samples

Payload

application/json

{"itemIds": [1000000214,
1000000216
],
"eventSource": "cpmmerce",
"accountId": "8739392294",
"stage": "dev02"
}

Response samples

200
500

application/json

"Event source must be from commerce"

Get Bulk upload status by Key Id

Request

path Parameters

keyId

required

string

Get Bulk Upload By Key Params

Example: 606b6bf14ae47c00080798f3

Responses

200

Get Bulk upload status by Key Id

400

A generic client error

401

A generic Unauthorized Error

500

A generic server error

get/inventory/bulk-upload-status/{keyId}

Response samples

200
400
401
500

application/json

{"_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

Request

Request Body schema: application/json

Array (non-empty)

sku	string non-empty
itemId	number >= 1
totalQuantity	number >= 0
reservedQuantity	number >= 0
locationId	number >= 0
type	string Enum: "Stock" "Transit"
channelId	number Enum: 12 13
transitRef	string
transitOrderDate	string
transitStockDate	string

Responses

200

Bulk Insert Inventories

400

A generic client error

401

A generic Unauthorized Error

500

A generic server error

post/inventory/bulk-insert

Request samples

Payload

application/json

[{"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"
}
]

Response samples

200
400
401
500

application/json

[{"_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)"
]
}
]

Warehouse

Warehouse APIs

Get Warehouse

Request

query Parameters

object

header Parameters

Authorization

required

string

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwYWZmMTcxNDNlMTU0MDAwODBhZmZkNSIsInJvbGVzIjpbIkFkbWluIl0sInBlcm1pc3Npb25zIjpbIndyaXRlOnNrdXNldCIsInJlYWQ6YXR0cmlidXRlLWdyb3VwIiwicmVhZDphdHRyaWJ1dGUiLCJ3cml0ZTpyb2xlIiwid3JpdGU6dXNlciIsIndyaXRlOmF0dHJpYnV0ZS1ncm91cCIsIndyaXRlOmNvbGxlY3Rpb24iLCJyZWFkOnNrdXNldCIsInJlYWQ6Y29sbGVjdGlvbiIsInJlYWQ6dXNlciIsInJlYWQ6cGVybWlzc2lvbiIsInJlYWQ6cm9sZSIsIndyaXRlOmF0dHJpYnV0ZSJdLCJhY2NvdW50IjoiNjBhYzE5ZWY4OTNhYjEwMDA4NjRiNzcxIiwiYWNjb3VudElkIjoxNTMzMzUyNTYxLCJ1c2VyVHlwZSI6eyJraW5kIjoiUkVHSVNURVJFRCJ9LCJpYXQiOjE2MjM3MDM3ODQsImV4cCI6MTcyMzcwNTU4NH0.MI_eTWLzfkkFCex7vK8FtFw4suC0DrvBb-QozeX0KRWSRmm5DYrzOuj_br7SWi6YOdYyjPy_jz0CXNLThuYkng'

Responses

200

Get List Of Warehouses

400

A generic client error

401

A generic Unauthorized Error

500

A generic server error

get/warehouse

Response samples

200
400
401
500

application/json

{"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

Request

header Parameters

Authorization

required

string

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwYWZmMTcxNDNlMTU0MDAwODBhZmZkNSIsInJvbGVzIjpbIkFkbWluIl0sInBlcm1pc3Npb25zIjpbIndyaXRlOnNrdXNldCIsInJlYWQ6YXR0cmlidXRlLWdyb3VwIiwicmVhZDphdHRyaWJ1dGUiLCJ3cml0ZTpyb2xlIiwid3JpdGU6dXNlciIsIndyaXRlOmF0dHJpYnV0ZS1ncm91cCIsIndyaXRlOmNvbGxlY3Rpb24iLCJyZWFkOnNrdXNldCIsInJlYWQ6Y29sbGVjdGlvbiIsInJlYWQ6dXNlciIsInJlYWQ6cGVybWlzc2lvbiIsInJlYWQ6cm9sZSIsIndyaXRlOmF0dHJpYnV0ZSJdLCJhY2NvdW50IjoiNjBhYzE5ZWY4OTNhYjEwMDA4NjRiNzcxIiwiYWNjb3VudElkIjoxNTMzMzUyNTYxLCJ1c2VyVHlwZSI6eyJraW5kIjoiUkVHSVNURVJFRCJ9LCJpYXQiOjE2MjM3MDM3ODQsImV4cCI6MTcyMzcwNTU4NH0.MI_eTWLzfkkFCex7vK8FtFw4suC0DrvBb-QozeX0KRWSRmm5DYrzOuj_br7SWi6YOdYyjPy_jz0CXNLThuYkng'

Request Body schema: application/json

channel	Array of integers
isActive required	boolean
isDefault	boolean
pickup	boolean
name required	string [ 2 .. 140 ]
kind	string <= 140 characters
required	object
shortName	string [ 2 .. 24 ] characters
type	string 24 characters

Responses

200

Successfully Created Warehouse

400

A generic client error

401

A generic Unauthorized Error

500

A generic server error

post/warehouse

Request samples

Payload

application/json

{"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"
}

Response samples

200
400
401
500

application/json

{"_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

Request

header Parameters

Authorization

required

string

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwYWZmMTcxNDNlMTU0MDAwODBhZmZkNSIsInJvbGVzIjpbIkFkbWluIl0sInBlcm1pc3Npb25zIjpbIndyaXRlOnNrdXNldCIsInJlYWQ6YXR0cmlidXRlLWdyb3VwIiwicmVhZDphdHRyaWJ1dGUiLCJ3cml0ZTpyb2xlIiwid3JpdGU6dXNlciIsIndyaXRlOmF0dHJpYnV0ZS1ncm91cCIsIndyaXRlOmNvbGxlY3Rpb24iLCJyZWFkOnNrdXNldCIsInJlYWQ6Y29sbGVjdGlvbiIsInJlYWQ6dXNlciIsInJlYWQ6cGVybWlzc2lvbiIsInJlYWQ6cm9sZSIsIndyaXRlOmF0dHJpYnV0ZSJdLCJhY2NvdW50IjoiNjBhYzE5ZWY4OTNhYjEwMDA4NjRiNzcxIiwiYWNjb3VudElkIjoxNTMzMzUyNTYxLCJ1c2VyVHlwZSI6eyJraW5kIjoiUkVHSVNURVJFRCJ9LCJpYXQiOjE2MjM3MDM3ODQsImV4cCI6MTcyMzcwNTU4NH0.MI_eTWLzfkkFCex7vK8FtFw4suC0DrvBb-QozeX0KRWSRmm5DYrzOuj_br7SWi6YOdYyjPy_jz0CXNLThuYkng'

Request Body schema: application/json

offset	integer >= 0 Default: 0
limit	integer >= 1 Default: 10
queryType	string Default: "paginated" Enum: "paginated" "suggested"
warehouseId	number
searchTerm	string

Responses

200

Get List Of inventory based on a query

400

A generic client error

401

A generic Unauthorized Error

404

Location Not Found Error

500

A generic server error

post/warehouse/query

Request samples

Payload

application/json

{"offset": 0,
"limit": 10,
"queryType": "paginated",
"warehouseId": 1000000608,
"searchTerm": "Warehouse"
}

Response samples

200
400
401
404
500

application/json

{"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

Request

path Parameters

warehouseId

required

number

Warehouse Id

Example: 1

header Parameters

Authorization

required

string

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwYWZmMTcxNDNlMTU0MDAwODBhZmZkNSIsInJvbGVzIjpbIkFkbWluIl0sInBlcm1pc3Npb25zIjpbIndyaXRlOnNrdXNldCIsInJlYWQ6YXR0cmlidXRlLWdyb3VwIiwicmVhZDphdHRyaWJ1dGUiLCJ3cml0ZTpyb2xlIiwid3JpdGU6dXNlciIsIndyaXRlOmF0dHJpYnV0ZS1ncm91cCIsIndyaXRlOmNvbGxlY3Rpb24iLCJyZWFkOnNrdXNldCIsInJlYWQ6Y29sbGVjdGlvbiIsInJlYWQ6dXNlciIsInJlYWQ6cGVybWlzc2lvbiIsInJlYWQ6cm9sZSIsIndyaXRlOmF0dHJpYnV0ZSJdLCJhY2NvdW50IjoiNjBhYzE5ZWY4OTNhYjEwMDA4NjRiNzcxIiwiYWNjb3VudElkIjoxNTMzMzUyNTYxLCJ1c2VyVHlwZSI6eyJraW5kIjoiUkVHSVNURVJFRCJ9LCJpYXQiOjE2MjM3MDM3ODQsImV4cCI6MTcyMzcwNTU4NH0.MI_eTWLzfkkFCex7vK8FtFw4suC0DrvBb-QozeX0KRWSRmm5DYrzOuj_br7SWi6YOdYyjPy_jz0CXNLThuYkng'

Responses

200

Successfully Return Warehouse

400

A generic client error

401

A generic Unauthorized Error

404

Location Not Found Error

500

A generic server error

get/warehouse/{warehouseId}

Response samples

200
400
401
404
500

application/json

{"_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

Request

path Parameters

warehouseId

required

number

Warehouse Id

Example: 1

header Parameters

Authorization

required

string

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwYWZmMTcxNDNlMTU0MDAwODBhZmZkNSIsInJvbGVzIjpbIkFkbWluIl0sInBlcm1pc3Npb25zIjpbIndyaXRlOnNrdXNldCIsInJlYWQ6YXR0cmlidXRlLWdyb3VwIiwicmVhZDphdHRyaWJ1dGUiLCJ3cml0ZTpyb2xlIiwid3JpdGU6dXNlciIsIndyaXRlOmF0dHJpYnV0ZS1ncm91cCIsIndyaXRlOmNvbGxlY3Rpb24iLCJyZWFkOnNrdXNldCIsInJlYWQ6Y29sbGVjdGlvbiIsInJlYWQ6dXNlciIsInJlYWQ6cGVybWlzc2lvbiIsInJlYWQ6cm9sZSIsIndyaXRlOmF0dHJpYnV0ZSJdLCJhY2NvdW50IjoiNjBhYzE5ZWY4OTNhYjEwMDA4NjRiNzcxIiwiYWNjb3VudElkIjoxNTMzMzUyNTYxLCJ1c2VyVHlwZSI6eyJraW5kIjoiUkVHSVNURVJFRCJ9LCJpYXQiOjE2MjM3MDM3ODQsImV4cCI6MTcyMzcwNTU4NH0.MI_eTWLzfkkFCex7vK8FtFw4suC0DrvBb-QozeX0KRWSRmm5DYrzOuj_br7SWi6YOdYyjPy_jz0CXNLThuYkng'

Request Body schema: application/json

channel	Array of integers
isActive required	boolean
isDefault	boolean
pickup	boolean
name required	string [ 2 .. 140 ]
kind	string <= 140 characters
required	object
shortName	string [ 2 .. 24 ] characters
type	string 24 characters

Responses

200

Successfully Updated Warehouse

400

A generic client error

401

A generic Unauthorized Error

404

Location Not Found Error

500

A generic server error

patch/warehouse/{warehouseId}

Request samples

Payload

application/json

{"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"
}

Response samples

200
400
401
404
500

application/json

{"_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 Channels

Get list of all available channels

Request

header Parameters

Authorization

required

string

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwYWZmMTcxNDNlMTU0MDAwODBhZmZkNSIsInJvbGVzIjpbIkFkbWluIl0sInBlcm1pc3Npb25zIjpbIndyaXRlOnNrdXNldCIsInJlYWQ6YXR0cmlidXRlLWdyb3VwIiwicmVhZDphdHRyaWJ1dGUiLCJ3cml0ZTpyb2xlIiwid3JpdGU6dXNlciIsIndyaXRlOmF0dHJpYnV0ZS1ncm91cCIsIndyaXRlOmNvbGxlY3Rpb24iLCJyZWFkOnNrdXNldCIsInJlYWQ6Y29sbGVjdGlvbiIsInJlYWQ6dXNlciIsInJlYWQ6cGVybWlzc2lvbiIsInJlYWQ6cm9sZSIsIndyaXRlOmF0dHJpYnV0ZSJdLCJhY2NvdW50IjoiNjBhYzE5ZWY4OTNhYjEwMDA4NjRiNzcxIiwiYWNjb3VudElkIjoxNTMzMzUyNTYxLCJ1c2VyVHlwZSI6eyJraW5kIjoiUkVHSVNURVJFRCJ9LCJpYXQiOjE2MjM3MDM3ODQsImV4cCI6MTcyMzcwNTU4NH0.MI_eTWLzfkkFCex7vK8FtFw4suC0DrvBb-QozeX0KRWSRmm5DYrzOuj_br7SWi6YOdYyjPy_jz0CXNLThuYkng'

Responses

200

Get List of channels

400

A generic client error

401

A generic Unauthorized Error

500

A generic server error

get/warehouse/channels

Response samples

200
400
401
500

application/json

[{"_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

Request

header Parameters

Authorization

required

string

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwYWZmMTcxNDNlMTU0MDAwODBhZmZkNSIsInJvbGVzIjpbIkFkbWluIl0sInBlcm1pc3Npb25zIjpbIndyaXRlOnNrdXNldCIsInJlYWQ6YXR0cmlidXRlLWdyb3VwIiwicmVhZDphdHRyaWJ1dGUiLCJ3cml0ZTpyb2xlIiwid3JpdGU6dXNlciIsIndyaXRlOmF0dHJpYnV0ZS1ncm91cCIsIndyaXRlOmNvbGxlY3Rpb24iLCJyZWFkOnNrdXNldCIsInJlYWQ6Y29sbGVjdGlvbiIsInJlYWQ6dXNlciIsInJlYWQ6cGVybWlzc2lvbiIsInJlYWQ6cm9sZSIsIndyaXRlOmF0dHJpYnV0ZSJdLCJhY2NvdW50IjoiNjBhYzE5ZWY4OTNhYjEwMDA4NjRiNzcxIiwiYWNjb3VudElkIjoxNTMzMzUyNTYxLCJ1c2VyVHlwZSI6eyJraW5kIjoiUkVHSVNURVJFRCJ9LCJpYXQiOjE2MjM3MDM3ODQsImV4cCI6MTcyMzcwNTU4NH0.MI_eTWLzfkkFCex7vK8FtFw4suC0DrvBb-QozeX0KRWSRmm5DYrzOuj_br7SWi6YOdYyjPy_jz0CXNLThuYkng

Request Body schema: application/json

required

Array of objects

Responses

200

Get List of channels Statuses

400

A generic client error

401

A generic Unauthorized Error

500

A generic server error

post/warehouse/channels/status

Request samples

Payload

application/json

{"channels": [{"label": "Channel 11",
"value": 11
}
]
}

Response samples

200
400
401
500

application/json

{"channelsStatus": [{"channelId": 11,
"active": 1,
"isActive": 1,
"total": 7
}
]
}

Fulfillment-method

Fulfillment-method APIs

Get All Fulfillment Methods

Request

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Get All Fulfilment Methods

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

get/fulfillment-method

Response samples

200
400
401
403
500

application/json

[{"_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

Request

header Parameters

Authorization

required

string

Example: JWT

Request Body schema: application/json

name

required

string [ 2 .. 140 ] characters

Responses

200

Successfully Created Fulfilment Method

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

post/fulfillment-method

Request samples

Payload

application/json

{"name": "Bellevue Warehouse Main"
}

Response samples

200
400
401
403
500

application/json

{"_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

Request

path Parameters

methodId

required

string

Fulfilment Method Id

Example: 606b6bf14ae47c00080798f3

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Get Fulfilment Method By ID

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

404

Fulfilment Method Not Found Error

500

A generic server error

get/fulfillment-method/{methodId}

Response samples

application/json

{"_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

Request

path Parameters

methodId

required

string

Fulfilment Method Id

Example: 606b6bf14ae47c00080798f3

header Parameters

Authorization

required

string

Example: JWT

Request Body schema: application/json

name

required

string [ 2 .. 140 ] characters

Responses

200

Update Fulfilment Method By ID

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

404

Fulfilment Method Not Found Error

500

A generic server error

patch/fulfillment-method/{methodId}

Request samples

Payload

application/json

{"name": "Bellevue Warehouse Main"
}

Response samples

application/json

{"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"name": "Bellevue Warehouse Main",
"priority": 65
}

Set Priority

Request

Request Body schema: application/json

required

Array of objects

Responses

200

Successfully Set Priority

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

post/fulfillment-method/set-priority

Request samples

Payload

application/json

{"method": [{"methodId": "5e4b0a8cef94d00b11acc382",
"priority": 50
}
]
}

Response samples

200
400
401
403
500

application/json

{"message": "Priority Updated Successfully",
"warnings": ["This Fulfillment ID :607f0b0cacc3d0000816203e does not exist"
]
}

Configurations

Configurations APIs

Create New Attribute

Request

header Parameters

Authorization

required

string

Example: JWT

Request Body schema: application/json

name required	string
level required	string Enum: "order" "item"
price	number
type required	string Enum: "bool" "string"
isDeleted	boolean
items	Array of strings

Responses

200

Successfully Created Attribute

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

post/attribute

Request samples

Payload

application/json

{"name": "Gift Messaging",
"level": "order",
"price": 50.25,
"type": "bool",
"isDeleted": false,
"items": [["1000083",
"1000084"
]
]
}

Response samples

200
400
401
403
500

application/json

{"_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

Request

path Parameters

id

required

string

Attribute Id for the object you need to retrieve

Example: 606b6bf14ae47c00080798f3

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Get Attribute

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

404

Object with the sent attribute Id is not found

500

A generic server error

get/attribute/{id}

Response samples

application/json

{"_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

Request

path Parameters

id

required

string

Attribute Id for the object you need to update

Example: 606b6bf14ae47c00080798f3

header Parameters

Authorization

required

string

Example: JWT

Request Body schema: application/json

name	string
level	string Enum: "order" "item"
price	number
type	string Enum: "bool" "string"
items	Array of strings

Responses

200

Successfully Updated Attribute

400

Object with the sent attribute Id is not found

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

patch/attribute/{id}

Request samples

Payload

application/json

{"name": "Gift Messaging",
"level": "order",
"price": 50.25,
"type": "bool",
"items": [["1000083",
"1000084"
]
]
}

Response samples

200
400
401
403
500

application/json

{"_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

Request

path Parameters

id

required

string

Attribute Id for the object you need to delete

Example: 606b6bf14ae47c00080798f3

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Successfully Deleted Attribute

400

Object with the sent attribute Id is not found or it is already deleted

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

delete/attribute/{id}

Response samples

200
400
401
403
500

application/json

{"_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

Request

query Parameters

offset	integer Default: 0 Example: offset=0
limit	integer Default: 10 Example: limit=10

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Attributes response

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

get/attribute/getAll

Response samples

200
400
401
403
500

application/json

{"query": {"offset": 0,
"limit": 10,
"count": 1000
},
"attributes": [{"_id": "5fee9d59f2f08a1b3cbdea08",
"name": "Gift Messaging",
"price": 50.25,
"type": "bool"
}
]
}

Restore Deleted Attribute

Request

path Parameters

id

required

string

Attribute Id

Example: 606b6bf14ae47c00080798f3

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Restore Deleted Attribute

400

Object with the sent attribute Id is not found or it is already restored

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

patch/attribute/restore/{id}

Response samples

200
400
401
403
500

application/json

{"_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

Get Deleted attribute from attributeId

Request

path Parameters

id

required

string

Attribute Id

Example: 606b6bf14ae47c00080798f3

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Get Deleted Attribute

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

404

Object with the sent attribute Id is not found

500

A generic server error

get/attribute/getDeleted/{id}

Response samples

application/json

{"_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 Order Attributes

Get All Order level Attributes

Request

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Get Order Level Attributes

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

get/attribute/getAll/order-attributes

Response samples

200
400
401
403
500

application/json

{"attributes": [{"_id": "5fee9d59f2f08a1b3cbdea08",
"name": "Gift Messaging",
"price": 50.25,
"type": "bool"
}
]
}

Get Settings

Request

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Get Fulfillment Setting

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

get/setting

Response samples

200
400
401
403
500

application/json

"distance"

Create Settings

Create or Update Store Settings

Request

header Parameters

Authorization

required

string

Example: JWT

Request Body schema: application/json

fulfillmentSetting

required

string

Enum: "distance" "custom"

Responses

200

Create Or Update Setting

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

post/setting

Request samples

Payload

application/json

{"fulfillmentSetting": "distance"
}

Response samples

200
400
401
403
500

application/json

{"_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 Cancellations Policies

Get Cancellation Policy

Request

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Get Cancellation Policy Successfully

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

404

Cancellation policy not found

500

A generic server error

get/setting/cancellation-policy

Response samples

application/json

{"autoRefund": true,
"isEnabled": true,
"windowHours": 12,
"statuses": ["ORDER_CREATED"
]
}

Create Cancellation Policy

Request

header Parameters

Authorization

required

string

Example: JWT

Request Body schema: application/json

autoRefund required	boolean
isEnabled required	boolean
windowHours required	number
statuses required	Array of strings

Responses

200

Create Cancellation Policy Successfully

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

post/setting/cancellation-policy

Request samples

Payload

application/json

{"autoRefund": true,
"isEnabled": true,
"windowHours": 12,
"statuses": ["ORDER_CREATED"
]
}

Response samples

200
400
401
403
500

application/json

{"autoRefund": true,
"isEnabled": true,
"windowHours": 12,
"statuses": ["ORDER_CREATED"
]
}

Update Cancellation Policy

Request

header Parameters

Authorization

required

string

Example: JWT

Request Body schema: application/json

Any of:

autoRefund required	boolean
isEnabled	boolean
windowHours	number
statuses	Array of strings

Responses

200

Update Cancellation Policy Successfully

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

patch/setting/cancellation-policy

Request samples

Payload

application/json

{"autoRefund": true,
"isEnabled": true,
"windowHours": 12,
"statuses": ["ORDER_CREATED"
]
}

Response samples

200
400
401
403
500

application/json

{"autoRefund": true,
"isEnabled": true,
"windowHours": 12,
"statuses": ["ORDER_CREATED"
]
}

Get Return Policies

Get Return Policy

Request

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Get Cancellation Policy Successfully

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

404

Return policy not found

500

A generic server error

get/setting/return-policy

Response samples

application/json

{"autoRefund": true,
"isEnabled": true,
"windowHours": 12,
"statuses": ["ORDER_CREATED"
]
}

Create Return Policy

Request

header Parameters

Authorization

required

string

Example: JWT

Request Body schema: application/json

autoRefund required	boolean
isEnabled required	boolean
windowHours required	number
statuses required	Array of strings

Responses

200

Create Return Policy Successfully

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

post/setting/return-policy

Request samples

Payload

application/json

{"autoRefund": true,
"isEnabled": true,
"windowHours": 12,
"statuses": ["ORDER_CREATED"
]
}

Response samples

200
400
401
403
500

application/json

{"autoRefund": true,
"isEnabled": true,
"windowHours": 12,
"statuses": ["ORDER_CREATED"
]
}

Update Return Policy

Request

header Parameters

Authorization

required

string

Example: JWT

Request Body schema: application/json

Any of:

autoRefund required	boolean
isEnabled	boolean
windowHours	number
statuses	Array of strings

Responses

200

Update Return Policy Successfully

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

patch/setting/return-policy

Request samples

Payload

application/json

{"autoRefund": true,
"isEnabled": true,
"windowHours": 12,
"statuses": ["ORDER_CREATED"
]
}

Response samples

200
400
401
403
500

application/json

{"autoRefund": true,
"isEnabled": true,
"windowHours": 12,
"statuses": ["ORDER_CREATED"
]
}

Get Sugar Refund Policies

Get Sugar Refund Policy

Request

header Parameters

Authorization

required

string

Example: JWT

Responses

200

Get Sugar Refund Policy Successfully

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

get/setting/sugar-refund-policy

Response samples

200
400
401
403
500

application/json

{"maxOrderValue": 1000,
"isEnabled": true,
"totalRefundsAllowed": 12,
"currency": "USD"
}

Create Sugar Refund Policy

Request

header Parameters

Authorization

required

string

Example: JWT

Request Body schema: application/json

maxOrderValue required	integer
isEnabled required	boolean
totalRefundsAllowed required	number
currency required	string

Responses

200

Create Sugar Refund Policy Successfully

400

A generic client error

401

A generic Unauthorized Error

403

A generic Forbidden Error

500

A generic server error

post/setting/sugar-refund-policy

Request samples

Payload

application/json

{"maxOrderValue": 1000,
"isEnabled": true,
"totalRefundsAllowed": 12,
"currency": "USD"
}

Response samples

200
400
401