Order Management System (1.0.0)

Download OpenAPI specification:Download

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

Order Management System

Cart

Cart APIs

Note: These are the legacy Cart APIs. To view fabric's new Cart APIs, navigate to Cart API > Cart from the left side navigation pane.

Add item to cart

Request

header Parameters

x-site-context	string (x-site-context) Object passed as string contains accountId, stage, channel, date Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}
Authorization	string Example: JWT token

Request Body schema: application/json

cartId required	string
userAuthToken	string
company	string
required	Array of objects non-empty

Responses

200

Item added to cart

400

A generic client error

401

Invalid/No userAuthToken provided

404

Item not In Stock

500

A generic server error

post/api-cart/cart/item

Request samples

Payload

application/json

{"cartId": "123456abcdef123456abcdef",
"userAuthToken": "JWT",
"company": "Fabric Inc.",
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"extra": { }
}
]
}

Response samples

application/json

{"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Get cart for the given cart ID or user auth token

Request

query Parameters

object or object

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Responses

200

Cart for the given cart id or user auth token

400

A generic client error

404

Cart not found

500

A generic server error

get/api-cart/cart

Response samples

application/json

{"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Remove item from cart by line item ID

Request

path Parameters

cartId required	string 24 characters Example: 5e5818a84d030c206b2ffb02
lineItemId required	number >= 1 Example: 5

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Responses

200

Cart after removing item

400

Cart is already empty

404

Cart not found

500

A generic server error

patch/api-cart/cart/{cartId}/item/{lineItemId}

Response samples

application/json

{"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Empty cart for the given cart ID

Request

path Parameters

cartId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Responses

200

Empty Cart

400

A generic client error

404

Cart not found

500

A generic server error

patch/api-cart/cart/{cartId}/empty

Response samples

application/json

{"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Update cart

Request

path Parameters

cartId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Request Body schema: application/json

Array of objects non-empty

Responses

200

Updated Cart

400

A generic client error

404

Cart not found

500

A generic server error

patch/api-cart/cart/{cartId}/items

Request samples

Payload

application/json

{"items": [{"itemId": 1234567,
"priceListId": 100000012,
"quantity": 3,
"discountedQuantity": 3,
"lineItemId": 3,
"isUnique": "123",
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
}
}
]
}

Response samples

application/json

{"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Add promotion to cart

Request

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Request Body schema: application/json

cartId required	string
promoName required	string

Responses

200

Add promo to cart

400

Promo is alerady applied

404

Promo not found

500

A generic server error

patch/api-cart/cart/apply-promo

Request samples

Payload

application/json

{"cartId": "5e5ebf27f1f734055d035833",
"promoName": "CR100"
}

Response samples

application/json

{"deleted": false,
"allPromosApplied": [{"promoId": "5ddd1a156c5a5fed1e0d91fb",
"promoCode": "10_DOLLORS_OFF_123"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Remove promotion from cart

Request

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Request Body schema: application/json

promoId required	string 24 characters
cartId required	string

Responses

200

Remove promo from cart

400

A generic client error

404

Cart not found

500

A generic server error

patch/api-cart/cart/remove-promo

Request samples

Payload

application/json

{"promoId": "5ddd1a156c5a5fed1e0d91fb",
"cartId": "607f8a8f0118960009a8e6ee"
}

Response samples

application/json

{"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Merge user cart and guest cart

Request

header Parameters

x-site-context	string (x-site-context) Object passed as string contains accountId, stage, channel, date Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}
Authorization	string Example: JWT

Request Body schema: application/json

guestCartId

required

string 24 characters

Responses

200

Merged cart

400

A generic client error

401

Invalid/No userAuthToken provided

404

Cart not found

500

A generic server error

patch/api-cart/cart/merge

Request samples

Payload

application/json

{"guestCartId": "5e5818a84d030c206b2ffb02"
}

Response samples

application/json

{"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

[Deprecated] Cart soft delete

Cart soft delete, add the deleted boolean flag as true and add the order number to the cart.

Request

path Parameters

cartId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

Request Body schema: application/json

orderNumber

required

string 15 characters

Responses

200

Cart soft delete, add the deleted boolean flag as true and add the order number to the cart.

400

A generic client error

404

Cart not found

500

A generic server error

patch/api-cart/cart/{cartId}/orderNumber

Request samples

Payload

application/json

{"orderNumber": "1234-1234-12345"
}

Response samples

application/json

{"deleted": true,
"allPromosApplied": [ ],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Cart soft delete

Cart soft delete, add the deleted boolean flag as true and add the order number to the cart.

Request

path Parameters

cartId

string 24 characters

Example: 5e5818a84d030c206b2ffb02

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Request Body schema: application/json

orderNumber

required

string 15 characters

Responses

200

Cart soft delete, add the deleted boolean flag as true and add the order number to the cart.

400

A generic client error

404

Cart not found

500

A generic server error

delete/api-cart/cart/{cartId}

Request samples

Payload

application/json

{"orderNumber": "1234-1234-12345"
}

Response samples

application/json

{"deleted": true,
"allPromosApplied": [ ],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Add shipTo IDs to cart items

Request

path Parameters

cartId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Request Body schema: application/json

Array (non-empty)

itemId required	string
lineItemId required	number
shipTo	string 24 characters

Responses

200

shipTo added to cart

400

A generic client error

500

A generic server error

patch/api-cart/cart/{cartId}/ship-to

Request samples

Payload

application/json

[{"itemId": 123456,
"lineItemId": 3,
"shipTo": "5e5818a84d030c206b2ffb02"
}
]

Response samples

application/json

{"deleted": false,
"allPromosApplied": [ ],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Add shipTo IDs to cart items (v1)

Request

path Parameters

cartId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Request Body schema: application/json

Array (non-empty)

itemId required	string
lineItemId required	number
shipTo	string 24 characters

Responses

200

shipTo added to cart

400

A generic client error

404

Cart not found

500

A generic server error

patch/api-cart/cart/{cartId}/ship-to/v1

Request samples

Payload

application/json

[{"itemId": 123456,
"lineItemId": 3,
"shipTo": "5e5818a84d030c206b2ffb02"
}
]

Response samples

application/json

{"deleted": false,
"allPromosApplied": [ ],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Update cart status

Request

path Parameters

cartId required	string 24 characters Example: 5e5818a84d030c206b2ffb02
updatedStatus required	string Example: pending

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Responses

200

Cart with updated status

400

User cannot have more than one pending cart.

404

Cart not found

500

A generic server error

patch/api-cart/cart/{cartId}/status/{updatedStatus}

Response samples

application/json

{"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Query on carts

Find a specific carts that matches the filters

Request

header Parameters

x-site-context	string (x-site-context) Object passed as string contains accountId, stage, channel, date Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}
x-api-key	string Example: 0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k

Request Body schema: application/json

offset	number >= 0 Default: 0
limit	number [ 1 .. 500 ] Default: 10
	object or object or object or object or object or object or object

Responses

200

Matched carts to filters

400

A generic client error

403

Missing x-api-key in header

500

A generic server error

post/api-cart/cart/query

Request samples

Payload

application/json

{"offset": 0,
"limit": 10,
"filters": {"date": {"gte": "2019-12-14T23:20:50.52Z",
"lte": "2019-12-14T23:20:50.52Z"
},
"userId": "string",
"approver": "string",
"account": "string",
"po": "string",
"company": "string",
"status": ["pending"
]
}
}

Response samples

application/json

{"query": {"limit": 10,
"offset": 0,
"count": 1
},
"carts": [{"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [null
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": null,
"createdAt": null,
"updatedAt": null,
"attention": null,
"street1": null,
"street2": null,
"city": null,
"state": null,
"country": null,
"zipCode": null,
"kind": null,
"name": { },
"phone": { },
"email": null,
"shipTo": { },
"shipToId": null,
"cartId": { },
"taxCode": null,
"shipToType": null
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
]
}

Update cart header

Request

path Parameters

cartId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Request Body schema: application/json

Any of:

account required	string
approver	string
company	string
po	string
extra	object

Responses

200

cart with update header

400

A generic client error

500

A generic server error

patch/api-cart/cart/{cartId}/header

Request samples

Payload

application/json

{"account": "string",
"approver": "string",
"company": "string",
"po": "string",
"extra": { }
}

Response samples

application/json

{"extra": { },
"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Cart soft delete (cart decoupled)

Cart soft delete, add the deleted boolean flag as true and add the order number to the cart (cart decoupled)

Request

path Parameters

cartId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Request Body schema: application/json

orderNumber

required

string 15 characters

Responses

200

Soft delete cart

400

A generic client error

404

Cart not found

500

A generic server error

delete/api-cart/cart-decoupled/{cartId}

Request samples

Payload

application/json

{"orderNumber": "1234-1234-12345"
}

Response samples

application/json

{"registeredUser": false,
"account": "string",
"approver": "string",
"po": "string",
"cartId": 111166,
"status": "pending",
"allPromosApplied": [ ],
"attributes": [ ],
"__v": 0,
"totalAmount": {"currency": "USD",
"amount": 38
},
"quantity": 2,
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"deleted": true,
"items": [{"price": {"discount": {"discountAmount": 0,
"price": 0,
"promosApplied": [ ]
},
"sale": 0,
"base": 19,
"currency": "USD"
},
"sample": false,
"isUnique": false,
"discountedQuantity": 0,
"group": ["123123123123123123123123"
],
"weightUnit": "lb",
"isPickup": false,
"itemId": 15,
"sku": "sk231212",
"taxCode": "TC1234567890",
"title": "fabric t-shirt",
"weight": 4.2,
"quantity": 2,
"lineItemId": 1,
"attributeTotalPrice": 0,
"totalPrice": {"currency": "USD",
"amount": 38
},
"attributes": [ ],
"id": "6141a40c13f13a000876272a",
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
]
}

Bill To

Bill To APIs [Deprecated]

Create billto for a shipment [Deprecated]

Create billto for a shipment

Request

path Parameters

cartId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

Request Body schema: application/json

paymentMethod required	string [ 3 .. 24 ] characters
cardIdentifier required	string 4 characters
amount required	number >= 0.01
required	object

Responses

200

Bill To For Shipment Created

400

A generic client error

404

Cart not found

500

A generic server error

post/api-cart/bill-to/cart/{cartId}

Request samples

Payload

application/json

{"paymentMethod": "Visa Credit",
"cardIdentifier": "1234",
"amount": 149.99,
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
}
}

Response samples

application/json

{"paymentMethod": "Visa Credit",
"cardIdentifier": "1234",
"amount": 149.99,
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"billToId": 1,
"cart": "5e5818a84d030c206b2ffb02",
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Get bill-to by ID [Deprecated]

Get bill-to by ID

Request

path Parameters

billToId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

Responses

200

Getting Bill To By ID

400

A generic client error

404

BillTo not found

500

A generic server error

get/api-cart/bill-to/{billToId}

Response samples

application/json

{"paymentMethod": "Visa Credit",
"cardIdentifier": "1234",
"amount": 149.99,
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"billToId": 1,
"cart": "5e5818a84d030c206b2ffb02",
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"__v": 0
}

Get bill-to by shipToId [Deprecated]

Get bill-to by shipToId

Request

path Parameters

shipToId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

Responses

200

Getting Bill To By ID

400

A generic client error

404

ShipTo not found

500

A generic server error

get/api-cart/bill-to/ship-to/{shipToId}

Response samples

application/json

{"shipMethod": {"shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
"shipmentCarrier": "Fedex",
"shipmentMethod": "Next Day",
"cost": {"currency": "USD",
"amount": 5.99
}
},
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"billTo": [{"paymentMethod": "Visa Credit",
"cardIdentifier": "1234",
"amount": 149.99,
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"billToId": 1,
"cart": "5e5818a84d030c206b2ffb02",
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"__v": 0
}
],
"shipToType": "SHIP_TO_ADDRESS",
"taxCode": "FR1000",
"shipToId": 1,
"__v": 0,
"cartId": "5e5818a84d030c206b2ffb02",
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Update billto for a shipment [Deprecated]

Update billto for a shipment

Request

path Parameters

cartId required	string 24 characters Example: 5e5818a84d030c206b2ffb02
billToId required	string 24 characters Example: 5e5818a84d030c206b2ffb02

Request Body schema: application/json

paymentMethod	string [ 3 .. 24 ] characters
cardIdentifier	string 4 characters
amount	number >= 0.01
	object

Responses

200

Bill To For Shipment Updated

400

A generic client error

500

A generic server error

patch/api-cart/cart/{cartId}/bill-to/{billToId}

Request samples

Payload

application/json

{"paymentMethod": "Visa Credit",
"cardIdentifier": "1234",
"amount": 149.99,
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
}
}

Response samples

application/json

{"paymentMethod": "Visa Credit",
"cardIdentifier": "1234",
"amount": 149.99,
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"billToId": 1,
"cart": "5e5818a84d030c206b2ffb02",
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"__v": 0
}

Ship To

Ship To APIs

Note: These are the legacy Ship To APIs. To view fabric's new Shipping APIs, navigate to Cart API > Shipping from the left side navigation pane.

Create ship-to

Request

path Parameters

cartId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Request Body schema: application/json

shipToType required	string Enum: "BOPIS" "SHIP_TO_STORE" "SHIP_TO_ADDRESS" "STORE_PICKUP"
warehouseId	string 24 characters
isPickup	boolean
required	object
taxCode	string
storeId	string [ 5 .. 50 ] characters
	object
	object
required	object

Responses

200

Ship To Created

400

A generic client error

404

Cart not found

500

A generic server error

post/api-cart/ship-to/cart/{cartId}

Request samples

Payload

application/json

{"shipToType": "SHIP_TO_ADDRESS",
"warehouseId": "123456abcdef123456abcdef",
"isPickup": true,
"shipMethod": {"shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
"shipmentCarrier": "Fedex",
"shipmentMethod": "Next Day",
"cost": {"currency": "USD",
"amount": 5.99
}
},
"taxCode": "FR1000",
"storeId": "TBD",
"pickupPerson": {"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"altPickupPerson": {"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
}
}

Response samples

application/json

{"shipToType": "SHIP_TO_ADDRESS",
"warehouseId": "123456abcdef123456abcdef",
"isPickup": true,
"shipMethod": {"shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
"shipmentCarrier": "Fedex",
"shipmentMethod": "Next Day",
"cost": {"currency": "USD",
"amount": 5.99
}
},
"taxCode": "FR1000",
"storeId": "TBD",
"pickupPerson": {"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"altPickupPerson": {"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"cartId": "5e5818a84d030c206b2ffb02",
"shipToId": 13812,
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Get Cart data for the given shipTo ID

Request

path Parameters

shipToId

required

string 24 characters

Example: 5e5818a84d030c206b2ffb0

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Responses

200

Getting Cart data for the given shipTo ID

400

A generic client error

404

Cart not found

500

A generic server error

get/api-cart/ship-to/{shipToId}/cart

Response samples

application/json

{"deleted": false,
"allPromosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
],
"items": [{"itemId": 1000000012,
"priceListId": 100002,
"isUnique": 123,
"quantity": 2,
"price": {"currency": "USD",
"base": 15.99,
"sale": 10.99,
"discount": {"price": 10.99,
"discountAmount": 10.99,
"promosApplied": [{"unit": "string",
"value": 0,
"ON": {"kind": "SKU",
"value": ""
},
"id": "string",
"promoId": "string",
"promoCode": "string"
}
]
}
},
"group": ["5ddd1a156c5a5fed1e0d91fb"
],
"discountedQuantity": 0,
"lineItemId": 1,
"totalPrice": {"currency": "USD",
"amount": 200
},
"id": "5fee9d59f2f08a1b3cbdea08",
"sample": false,
"weightUnit": "kg",
"isPickup": false,
"sku": "blue",
"taxCode": "PH0607",
"title": "item title",
"weight": 7,
"attributeTotalPrice": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611",
"shipTo": {"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc",
"shipTo": {"shipMethod": {"shipMethodId": null,
"shipmentCarrier": null,
"shipmentMethod": null,
"cost": { }
}
},
"shipToId": 5269,
"cartId": "61e03ff6a865fe00094f8620",
"taxCode": "FR1000",
"shipToType": "SHIP_TO_ADDRESS"
}
}
],
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}
],
"registeredUser": false,
"cartId": 4,
"totalAmmount"": {"currency": "USD",
"amount": 200
},
"quantity": 2,
"__v": 0,
"attributes": [{"price": 10,
"_id": "6146e98408e3700008b64611",
"attributeId": "60a77de306f682000975c24c",
"value": "true/false",
"name": "Gift Message",
"type": "string",
"id": "6146e98408e3700008b64611"
}
],
"account": "string",
"approver": "string",
"po": "string",
"company": "string",
"status": "pending",
"extra": { },
"errors": {"inventory": [ ],
"price": [ ],
"promo": [ ]
},
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z"
}

Get ShipTo by ID

Request

path Parameters

shipTo

required

string 24 characters

Example: 5e5818a84d030c206b2ffb02

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Responses

200

Getting ShipTo by ID

400

A generic client error

404

ShipTo not found

500

A generic server error

get/api-cart/ship-to/{shipTo}

Response samples

application/json

{"shipToType": "SHIP_TO_ADDRESS",
"warehouseId": "123456abcdef123456abcdef",
"isPickup": true,
"shipMethod": {"shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
"shipmentCarrier": "Fedex",
"shipmentMethod": "Next Day",
"cost": {"currency": "USD",
"amount": 5.99
}
},
"taxCode": "FR1000",
"storeId": "TBD",
"pickupPerson": {"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"altPickupPerson": {"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"cartId": "5e5818a84d030c206b2ffb02",
"shipToId": 13812,
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"__v": 0
}

Update ship-to

Request

path Parameters

cartId required	string 24 characters Example: 5e5818a84d030c206b2ffb02
shipToId required	string 24 characters Example: 5e5818a84d030c206b2ffb02

header Parameters

x-site-context

string (x-site-context)

Object passed as string contains accountId, stage, channel, date

Example: {"date": "2021-12-16T13:33:06.888Z", "channel": 12, "account": "test","stage":"test"}

Request Body schema: application/json

shipToType	string Enum: "BOPIS" "SHIP_TO_STORE" "SHIP_TO_ADDRESS" "STORE_PICKUP"
warehouseId	string 24 characters
isPickup	boolean
	object
taxCode	string
storeId	string [ 5 .. 50 ] characters
	object
	object
	object

Responses

200

Ship To Updated

400

A generic client error

404

Cart not found

500

A generic server error

patch/api-cart/cart/{cartId}/ship-to/{shipToId}

Request samples

Payload

application/json

{"shipToType": "SHIP_TO_ADDRESS",
"warehouseId": "123456abcdef123456abcdef",
"isPickup": true,
"shipMethod": {"shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
"shipmentCarrier": "Fedex",
"shipmentMethod": "Next Day",
"cost": {"currency": "USD",
"amount": 5.99
}
},
"taxCode": "FR1000",
"storeId": "TBD",
"pickupPerson": {"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"altPickupPerson": {"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
}
}

Response samples

application/json

{"shipToType": "SHIP_TO_ADDRESS",
"warehouseId": "123456abcdef123456abcdef",
"isPickup": true,
"shipMethod": {"shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
"shipmentCarrier": "Fedex",
"shipmentMethod": "Next Day",
"cost": {"currency": "USD",
"amount": 5.99
}
},
"taxCode": "FR1000",
"storeId": "TBD",
"pickupPerson": {"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"altPickupPerson": {"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"address": {"attention": "Leave at the back door.",
"street1": "123 Main Street",
"street2": "ABC Boulevard",
"city": "Seattle",
"state": "WA",
"country": "United States of America",
"zipCode": "10008-1234",
"kind": "TBD",
"name": {"first": "John",
"last": "Smith"
},
"phone": {"number": "123-456-7890",
"kind": "Mobile"
},
"email": "johnsmith@fabric.inc"
},
"cartId": "5e5818a84d030c206b2ffb02",
"shipToId": 13812,
"_id": "5fee9d59f2f08a1b3cbdea08",
"createdAt": "2020-12-31T02:09:53.914Z",
"updatedAt": "2020-12-31T02:09:53.914Z",
"__v": 0
}

Create ship-to (v1)

Request