Create ship-to

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId} \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "shipToType": "SHIP_TO_ADDRESS",
  "shipMethod": {
    "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
    "cost": {
      "currency": "USD",
      "amount": 5.99
    },
    "shipmentCarrier": "Fedex",
    "shipmentMethod": "Next Day"
  },
  "address": {
    "street1": "123 Main Street",
    "city": "Seattle",
    "state": "WA",
    "country": "United States of America",
    "zipCode": "10008-1234",
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "[email protected]",
    "attention": "Leave at the back door.",
    "street2": "ABC Boulevard",
    "kind": "TBD",
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    }
  },
  "warehouseId": "123456abcdef123456abcdef",
  "isPickup": true,
  "taxCode": "FR1000",
  "storeId": "TBD",
  "pickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "[email protected]"
  },
  "altPickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "[email protected]"
  }
}
'

{
  "shipToType": "SHIP_TO_ADDRESS",
  "warehouseId": "123456abcdef123456abcdef",
  "isPickup": true,
  "shipMethod": {
    "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
    "cost": {
      "currency": "USD",
      "amount": 5.99
    },
    "shipmentCarrier": "Fedex",
    "shipmentMethod": "Next Day"
  },
  "taxCode": "FR1000",
  "storeId": "TBD",
  "pickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "[email protected]"
  },
  "altPickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "[email protected]"
  },
  "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": "[email protected]"
  },
  "cartId": "5e5818a84d030c206b2ffb02",
  "shipToId": 13812,
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z"
}

POST

api-cart

ship-to

cart

{cartId}

Create ship-to

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId} \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "shipToType": "SHIP_TO_ADDRESS",
  "shipMethod": {
    "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
    "cost": {
      "currency": "USD",
      "amount": 5.99
    },
    "shipmentCarrier": "Fedex",
    "shipmentMethod": "Next Day"
  },
  "address": {
    "street1": "123 Main Street",
    "city": "Seattle",
    "state": "WA",
    "country": "United States of America",
    "zipCode": "10008-1234",
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "[email protected]",
    "attention": "Leave at the back door.",
    "street2": "ABC Boulevard",
    "kind": "TBD",
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    }
  },
  "warehouseId": "123456abcdef123456abcdef",
  "isPickup": true,
  "taxCode": "FR1000",
  "storeId": "TBD",
  "pickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "[email protected]"
  },
  "altPickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "[email protected]"
  }
}
'

{
  "shipToType": "SHIP_TO_ADDRESS",
  "warehouseId": "123456abcdef123456abcdef",
  "isPickup": true,
  "shipMethod": {
    "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
    "cost": {
      "currency": "USD",
      "amount": 5.99
    },
    "shipmentCarrier": "Fedex",
    "shipmentMethod": "Next Day"
  },
  "taxCode": "FR1000",
  "storeId": "TBD",
  "pickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "[email protected]"
  },
  "altPickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "[email protected]"
  },
  "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": "[email protected]"
  },
  "cartId": "5e5818a84d030c206b2ffb02",
  "shipToId": 13812,
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z"
}

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

Path Parameters

cartId

string

required

Required string length: 24

Example:

"5e5818a84d030c206b2ffb02"

Body

application/json

shipToType

enum<string>

required

Available options:

BOPIS,

SHIP_TO_STORE,

SHIP_TO_ADDRESS,

STORE_PICKUP

Example:

"SHIP_TO_ADDRESS"

shipMethod

object

required

Show child attributes

shipMethod.shipMethodId

string

required

Minimum string length: 3

Example:

"1a2b3c4d5e6f7g8h9i0j"

shipMethod.cost

object

required

Show child attributes

shipMethod.cost.currency

string

required

Minimum string length: 3

Example:

"USD"

shipMethod.cost.amount

number

required

Required range: x >= 0

Example:

5.99

shipMethod.shipmentCarrier

string

Example:

"Fedex"

shipMethod.shipmentMethod

string

Example:

"Next Day"

address

object

required

Show child attributes

address.street1

string

required

Maximum string length: 140

Example:

"123 Main Street"

address.city

string

required

Maximum string length: 140

Example:

"Seattle"

address.state

string

required

Maximum string length: 25

Example:

"WA"

address.country

string

required

Maximum string length: 140

Example:

"United States of America"

address.zipCode

string

required

Required string length: 3 - 25

Example:

"10008-1234"

address.name

object

required

Show child attributes

address.name.first

string

Required string length: 2 - 50

Example:

"John"

address.name.last

string

Required string length: 2 - 50

Example:

"Smith"

address.email

string<email>

required

Required string length: 5 - 100

Example:

"[email protected]"

address.attention

string

Maximum string length: 140

Example:

"Leave at the back door."

address.street2

string

Maximum string length: 240

Example:

"ABC Boulevard"

address.kind

string

Maximum string length: 24

Example:

"TBD"

address.phone

object

Show child attributes

address.phone.number

string

required

Required string length: 5 - 25

Example:

"123-456-7890"

address.phone.kind

string

required

Required string length: 3 - 25

Example:

"Mobile"

warehouseId

string

Required string length: 24

Example:

"123456abcdef123456abcdef"

isPickup

boolean

Example:

true

taxCode

string

Example:

"FR1000"

storeId

string

Required string length: 5 - 50

Example:

"TBD"

pickupPerson

object

Show child attributes

pickupPerson.name

object

Show child attributes

pickupPerson.name.first

string

Required string length: 2 - 50

Example:

"John"

pickupPerson.name.last

string

Required string length: 2 - 50

Example:

"Smith"

pickupPerson.phone

object

Show child attributes

pickupPerson.phone.number

string

required

Required string length: 5 - 25

Example:

"123-456-7890"

pickupPerson.phone.kind

string

required

Required string length: 3 - 25

Example:

"Mobile"

pickupPerson.email

string<email>

Required string length: 5 - 100

Example:

"[email protected]"

altPickupPerson

object

Show child attributes

altPickupPerson.name

object

Show child attributes

altPickupPerson.name.first

string

Required string length: 2 - 50

Example:

"John"

altPickupPerson.name.last

string

Required string length: 2 - 50

Example:

"Smith"

altPickupPerson.phone

object

Show child attributes

altPickupPerson.phone.number

string

required

Required string length: 5 - 25

Example:

"123-456-7890"

altPickupPerson.phone.kind

string

required

Required string length: 3 - 25

Example:

"Mobile"

altPickupPerson.email

string<email>

Required string length: 5 - 100

Example:

"[email protected]"

Response

Ship To Created

shipToType

enum<string>

Available options:

BOPIS,

SHIP_TO_STORE,

SHIP_TO_ADDRESS,

STORE_PICKUP

Example:

"SHIP_TO_ADDRESS"

warehouseId

string

Required string length: 24

Example:

"123456abcdef123456abcdef"

isPickup

boolean

Example:

true

shipMethod

object

Show child attributes

shipMethod.shipMethodId

string

required

Minimum string length: 3

Example:

"1a2b3c4d5e6f7g8h9i0j"

shipMethod.cost

object

required

Show child attributes

shipMethod.cost.currency

string

required

Minimum string length: 3

Example:

"USD"

shipMethod.cost.amount

number

required

Required range: x >= 0

Example:

5.99

shipMethod.shipmentCarrier

string

Example:

"Fedex"

shipMethod.shipmentMethod

string

Example:

"Next Day"

taxCode

string

Example:

"FR1000"

storeId

string

Required string length: 5 - 50

Example:

"TBD"

pickupPerson

object

Show child attributes

pickupPerson.name

object

Show child attributes

pickupPerson.name.first

string

Required string length: 2 - 50

Example:

"John"

pickupPerson.name.last

string

Required string length: 2 - 50

Example:

"Smith"

pickupPerson.phone

object

Show child attributes

pickupPerson.phone.number

string

required

Required string length: 5 - 25

Example:

"123-456-7890"

pickupPerson.phone.kind

string

required

Required string length: 3 - 25

Example:

"Mobile"

pickupPerson.email

string<email>

Required string length: 5 - 100

Example:

"[email protected]"

altPickupPerson

object

Show child attributes

altPickupPerson.name

object

Show child attributes

altPickupPerson.name.first

string

Required string length: 2 - 50

Example:

"John"

altPickupPerson.name.last

string

Required string length: 2 - 50

Example:

"Smith"

altPickupPerson.phone

object

Show child attributes

altPickupPerson.phone.number

string

required

Required string length: 5 - 25

Example:

"123-456-7890"

altPickupPerson.phone.kind

string

required

Required string length: 3 - 25

Example:

"Mobile"

altPickupPerson.email

string<email>

Required string length: 5 - 100

Example:

"[email protected]"

address

object

Show child attributes

address.attention

string

Maximum string length: 140

Example:

"Leave at the back door."

address.street1

string

Maximum string length: 140

Example:

"123 Main Street"

address.street2

string

Maximum string length: 240

Example:

"ABC Boulevard"

address.city

string

Maximum string length: 140

Example:

"Seattle"

address.state

string

Maximum string length: 25

Example:

"WA"

address.country

string

Maximum string length: 140

Example:

"United States of America"

address.zipCode

string

Required string length: 3 - 25

Example:

"10008-1234"

address.kind

string

Maximum string length: 24

Example:

"TBD"

address.name

object

Show child attributes

address.name.first

string

Required string length: 2 - 50

Example:

"John"

address.name.last

string

Required string length: 2 - 50

Example:

"Smith"

address.phone

object

Show child attributes

address.phone.number

string

required

Required string length: 5 - 25

Example:

"123-456-7890"

address.phone.kind

string

required

Required string length: 3 - 25

Example:

"Mobile"

address.email

string<email>

Required string length: 5 - 100

Example:

"[email protected]"

cartId

string

Required string length: 24

Example:

"5e5818a84d030c206b2ffb02"

shipToId

number

Example:

13812

_id

string

Example:

"5fee9d59f2f08a1b3cbdea08"

createdAt

string

Example:

"2020-12-31T02:09:53.914Z"

updatedAt

string

Example:

"2020-12-31T02:09:53.914Z"

Overview Create ship-to (v1)

⌘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

Create ship-to

Headers

Path Parameters

Body

Response