Update shipping details for all items in a specific cart

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": "[email protected]",
    "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": "[email protected]"
  },
  "pickupPerson": {
    "name": {
      "first": "Pat",
      "middle": "E",
      "last": "Kake"
    },
    "phone": {
      "number": "123-456-7899",
      "kind": "MOBILE"
    },
    "email": "[email protected]"
  },
  "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": "[email protected]",
    "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": "[email protected]"
  },
  "pickupPerson": {
    "name": {
      "first": "Pat",
      "middle": "E",
      "last": "Kake"
    },
    "phone": {
      "number": "123-456-7899",
      "kind": "MOBILE"
    },
    "email": "[email protected]"
  },
  "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"
}

PATCH

carts

{cartId}

shipping-details

Update shipping details for all items in a specific cart

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": "[email protected]",
    "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": "[email protected]"
  },
  "pickupPerson": {
    "name": {
      "first": "Pat",
      "middle": "E",
      "last": "Kake"
    },
    "phone": {
      "number": "123-456-7899",
      "kind": "MOBILE"
    },
    "email": "[email protected]"
  },
  "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": "[email protected]",
    "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": "[email protected]"
  },
  "pickupPerson": {
    "name": {
      "first": "Pat",
      "middle": "E",
      "last": "Kake"
    },
    "phone": {
      "number": "123-456-7899",
      "kind": "MOBILE"
    },
    "email": "[email protected]"
  },
  "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"
}

Headers

x-site-context

string

required

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

x-api-key

string

API Key for Gateway

Example:

"zaCELgL.0imfnc8mVLWwsAawjYr4Rx-Af50DDqtlx"

Authorization

string

required

Authorization token for the user

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."

Path Parameters

cartId

string

required

ID of cart for which shipping data is being updated

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

Body

application/json

Request body containing shipping details to be updated

Shipping details to be updated

cartId

string

required

Cart ID

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

shipToId

string

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

shipMethod

object

Shipping method and details

Show child attributes

shipMethod.cost

object

Shipping cost

Show child attributes

shipMethod.cost.amount

number<double>

required

Shipping cost

Example:

10

shipMethod.cost.currency

string | null

Currency type

Example:

"USD"

shipMethod.cost.discount

number<double> | null

Shipping discount

Example:

5

shipMethod.shipMethodId

string

Shipping method ID

Example:

"1234"

shipMethod.shipmentCarrier

string | null

Shipment carrier

Example:

"FedEx"

shipMethod.shipmentMethod

string | null

Shipment method type

Example:

"Next Day"

address

object

Shipping address

Show child attributes

address.attention

string | null

Address recipient

Example:

"Billing manager"

address.street1

string | null

Address line 1

Example:

"100 NE 100th St."

address.street2

string | null

Address line 2

Example:

"Suite 710"

address.street3

string | null

Address line 3

Example:

"Seventh floor"

address.street4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

address.city

string | null

City name

Example:

"Seattle"

address.state

string | null

State name

Example:

"Washington"

address.country

string | null

Country name

Example:

"USA"

address.zipCode

string | null

Zip code

Example:

"98125"

address.email

string | null

Receiver's email address

Example:

"[email protected]"

address.kind

string | null

Address type

Example:

"shipping"

address.name

object

Recipient's name

Show child attributes

address.name.first

string | null

Individual's first name

Example:

"Pat"

address.name.middle

string | null

Individual's middle name or initial

Example:

"E"

address.name.last

string | null

Individual's last name

Example:

"Kake"

address.phone

object

address details for the shipping

Show child attributes

address.phone.number

string

required

Phone number

Example:

"123-456-7899"

address.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipToType

string | null

Shipping type

Example:

"SHIP_TO_ADDRESS"

taxCode

string | null

Shipping tax code

Example:

"FR1000"

isPickup

boolean | null

true: Item is set for pickup
false: Item is set for delivery

Example:

true

altPickupPerson

object

Alternative pickup person

Show child attributes

altPickupPerson.name

object

Name of pickup person

Show child attributes

altPickupPerson.name.first

string | null

Individual's first name

Example:

"Pat"

altPickupPerson.name.middle

string | null

Individual's middle name or initial

Example:

"E"

altPickupPerson.name.last

string | null

Individual's last name

Example:

"Kake"

altPickupPerson.phone

object

Number of pickup person

Show child attributes

altPickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

altPickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

altPickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

pickupPerson

object

Designated pickup person

Show child attributes

pickupPerson.name

object

Name of pickup person

Show child attributes

pickupPerson.name.first

string | null

Individual's first name

Example:

"Pat"

pickupPerson.name.middle

string | null

Individual's middle name or initial

Example:

"E"

pickupPerson.name.last

string | null

Individual's last name

Example:

"Kake"

pickupPerson.phone

object

Number of pickup person

Show child attributes

pickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

pickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

pickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

storeId

string | null

Store ID

Example:

"ABC-123"

estimatedShipDate

string<date-time> | null

Estimated date for shipping

Example:

"2022-02-18T15:12:40.974580"

estimatedDeliveryDate

string<date-time> | null

Estimated date for delivery

Example:

"2022-02-18T15:12:40.974580"

shipmentInstructions

string | null

Store ID

Example:

"Additional user instructions for shipping"

Response

Shipping response body

shipToId

string | null

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

cartId

string | null

Cart ID

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

createdAt

string<date-time> | null

Shipping details creation time

Example:

"2022-02-18T15:12:40.974580"

updatedAt

string<date-time> | null

Last time shipping details were updated

Example:

"2022-02-18T15:12:40.974580"

shipMethod

object

Shipping method and details

Show child attributes

shipMethod.cost

object

Shipping cost

Show child attributes

shipMethod.cost.amount

number<double>

required

Shipping cost

Example:

10

shipMethod.cost.currency

string | null

Currency type

Example:

"USD"

shipMethod.cost.discount

number<double> | null

Shipping discount

Example:

5

shipMethod.shipMethodId

string

Shipping method ID

Example:

"1234"

shipMethod.shipmentCarrier

string | null

Shipment carrier

Example:

"FedEx"

shipMethod.shipmentMethod

string | null

Shipment method type

Example:

"Next Day"

address

object

Shipping address

Show child attributes

address.attention

string | null

Address recipient

Example:

"Billing manager"

address.street1

string | null

Address line 1

Example:

"100 NE 100th St."

address.street2

string | null

Address line 2

Example:

"Suite 710"

address.street3

string | null

Address line 3

Example:

"Seventh floor"

address.street4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

address.city

string | null

City name

Example:

"Seattle"

address.state

string | null

State name

Example:

"Washington"

address.country

string | null

Country name

Example:

"USA"

address.zipCode

string | null

Zip code

Example:

"98125"

address.email

string | null

Receiver's email address

Example:

"[email protected]"

address.kind

string | null

Address type

Example:

"shipping"

address.name

object

Recipient's name

Show child attributes

address.name.first

string | null

Individual's first name

Example:

"Pat"

address.name.middle

string | null

Individual's middle name or initial

Example:

"E"

address.name.last

string | null

Individual's last name

Example:

"Kake"

address.phone

object

address details for the shipping

Show child attributes

address.phone.number

string

required

Phone number

Example:

"123-456-7899"

address.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipToType

string | null

Shipping type

Example:

"SHIP_TO_ADDRESS"

taxCode

string | null

Shipping tax code

Example:

"FR1000"

isPickup

boolean

true: Item is set for pickup
false: Item is set for delivery

Example:

true

altPickupPerson

object

Alternative pickup person

Show child attributes

altPickupPerson.name

object

Name of pickup person

Show child attributes

altPickupPerson.name.first

string | null

Individual's first name

Example:

"Pat"

altPickupPerson.name.middle

string | null

Individual's middle name or initial

Example:

"E"

altPickupPerson.name.last

string | null

Individual's last name

Example:

"Kake"

altPickupPerson.phone

object

Number of pickup person

Show child attributes

altPickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

altPickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

altPickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

pickupPerson

object

Designated pickup person

Show child attributes

pickupPerson.name

object

Name of pickup person

Show child attributes

pickupPerson.name.first

string | null

Individual's first name

Example:

"Pat"

pickupPerson.name.middle

string | null

Individual's middle name or initial

Example:

"E"

pickupPerson.name.last

string | null

Individual's last name

Example:

"Kake"

pickupPerson.phone

object

Number of pickup person

Show child attributes

pickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

pickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

pickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

storeId

string | null

Store ID

Example:

"ABC-123"

estimatedShipDate

string<date-time> | null

Estimated date for shipping

Example:

"2022-02-18T15:12:40.974580"

estimatedDeliveryDate

string<date-time> | null

Estimated date for delivery

Example:

"2022-02-18T15:12:40.974580"

shipmentInstructions

string | null

Store ID

Example:

"Additional user instructions for shipping"

Create shipping details for specific items in specific cart Overview

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Update shipping details for all items in a specific cart

Headers

Path Parameters

Body

Response