curl --request PATCH \
--url https://prod.cart.fabric.inc/v2/carts/{cartId}/shipping-details \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'x-site-context: <x-site-context>' \
--data '{
"cartId": "d7e78a21-bee3-4448-bf1c-d5b5461dbda2",
"shipToId": "fef78121-bee3-4448-bf1c-d5b5461dbda2",
"shipMethod": {
"cost": {
"amount": 10,
"currency": "USD",
"discount": 5
},
"shipMethodId": "1234",
"shipmentCarrier": "FedEx",
"shipmentMethod": "Next Day"
},
"address": {
"attention": "Billing manager",
"street1": "100 NE 100th St.",
"street2": "Suite 710",
"street3": "Seventh floor",
"street4": "Attention: Pat E. Kake",
"city": "Seattle",
"state": "Washington",
"country": "USA",
"zipCode": "98125",
"email": "test@mail.com",
"kind": "shipping",
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
}
},
"shipToType": "SHIP_TO_ADDRESS",
"taxCode": "FR1000",
"isPickup": true,
"altPickupPerson": {
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
},
"email": "test@mail.com"
},
"pickupPerson": {
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
},
"email": "test@mail.com"
},
"warehouseId": "XYZ-1234",
"storeId": "ABC-123",
"estimatedShipDate": "2022-02-18T15:12:40.974580",
"estimatedDeliveryDate": "2022-02-18T15:12:40.974580",
"shipmentInstructions": "Additional user instructions for shipping"
}'
{
"shipToId": "fef78121-bee3-4448-bf1c-d5b5461dbda2",
"cartId": "d7e78a21-bee3-4448-bf1c-d5b5461dbda2",
"createdAt": "2022-02-18T15:12:40.974580",
"updatedAt": "2022-02-18T15:12:40.974580",
"shipMethod": {
"cost": {
"amount": 10,
"currency": "USD",
"discount": 5
},
"shipMethodId": "1234",
"shipmentCarrier": "FedEx",
"shipmentMethod": "Next Day"
},
"address": {
"attention": "Billing manager",
"street1": "100 NE 100th St.",
"street2": "Suite 710",
"street3": "Seventh floor",
"street4": "Attention: Pat E. Kake",
"city": "Seattle",
"state": "Washington",
"country": "USA",
"zipCode": "98125",
"email": "test@mail.com",
"kind": "shipping",
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
}
},
"shipToType": "SHIP_TO_ADDRESS",
"taxCode": "FR1000",
"isPickup": true,
"altPickupPerson": {
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
},
"email": "test@mail.com"
},
"pickupPerson": {
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
},
"email": "test@mail.com"
},
"warehouseId": "XYZ-1234",
"storeId": "ABC-123",
"estimatedShipDate": "2022-02-18T15:12:40.974580",
"estimatedDeliveryDate": "2022-02-18T15:12:40.974580",
"shipmentInstructions": "Additional user instructions for shipping"
}
Update shipping details for all items in a specified cart. Shipping details include the shipment’s delivery address, shipment method, pickup persons’ details, warehouse ID, store ID, and more.
curl --request PATCH \
--url https://prod.cart.fabric.inc/v2/carts/{cartId}/shipping-details \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'x-site-context: <x-site-context>' \
--data '{
"cartId": "d7e78a21-bee3-4448-bf1c-d5b5461dbda2",
"shipToId": "fef78121-bee3-4448-bf1c-d5b5461dbda2",
"shipMethod": {
"cost": {
"amount": 10,
"currency": "USD",
"discount": 5
},
"shipMethodId": "1234",
"shipmentCarrier": "FedEx",
"shipmentMethod": "Next Day"
},
"address": {
"attention": "Billing manager",
"street1": "100 NE 100th St.",
"street2": "Suite 710",
"street3": "Seventh floor",
"street4": "Attention: Pat E. Kake",
"city": "Seattle",
"state": "Washington",
"country": "USA",
"zipCode": "98125",
"email": "test@mail.com",
"kind": "shipping",
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
}
},
"shipToType": "SHIP_TO_ADDRESS",
"taxCode": "FR1000",
"isPickup": true,
"altPickupPerson": {
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
},
"email": "test@mail.com"
},
"pickupPerson": {
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
},
"email": "test@mail.com"
},
"warehouseId": "XYZ-1234",
"storeId": "ABC-123",
"estimatedShipDate": "2022-02-18T15:12:40.974580",
"estimatedDeliveryDate": "2022-02-18T15:12:40.974580",
"shipmentInstructions": "Additional user instructions for shipping"
}'
{
"shipToId": "fef78121-bee3-4448-bf1c-d5b5461dbda2",
"cartId": "d7e78a21-bee3-4448-bf1c-d5b5461dbda2",
"createdAt": "2022-02-18T15:12:40.974580",
"updatedAt": "2022-02-18T15:12:40.974580",
"shipMethod": {
"cost": {
"amount": 10,
"currency": "USD",
"discount": 5
},
"shipMethodId": "1234",
"shipmentCarrier": "FedEx",
"shipmentMethod": "Next Day"
},
"address": {
"attention": "Billing manager",
"street1": "100 NE 100th St.",
"street2": "Suite 710",
"street3": "Seventh floor",
"street4": "Attention: Pat E. Kake",
"city": "Seattle",
"state": "Washington",
"country": "USA",
"zipCode": "98125",
"email": "test@mail.com",
"kind": "shipping",
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
}
},
"shipToType": "SHIP_TO_ADDRESS",
"taxCode": "FR1000",
"isPickup": true,
"altPickupPerson": {
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
},
"email": "test@mail.com"
},
"pickupPerson": {
"name": {
"first": "Pat",
"middle": "E",
"last": "Kake"
},
"phone": {
"number": "123-456-7899",
"kind": "MOBILE"
},
"email": "test@mail.com"
},
"warehouseId": "XYZ-1234",
"storeId": "ABC-123",
"estimatedShipDate": "2022-02-18T15:12:40.974580",
"estimatedDeliveryDate": "2022-02-18T15:12:40.974580",
"shipmentInstructions": "Additional user instructions for shipping"
}
The x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"
API Key for Gateway
"zaCELgL.0imfnc8mVLWwsAawjYr4Rx-Af50DDqtlx"
Authorization token for the user
"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."
ID of cart for which shipping data is being updated
"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"
Request body containing shipping details to be updated
Shipping details to be updated
OK
Shipping response body
Was this page helpful?