Create shipping details

curl --request POST \
  --url https://api.fabric.inc/v3/carts/{cartId}/shipping-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "type": "SHIP_TO_ADDRESS",
  "address": {
    "addressLine1": "123 Main St.",
    "city": "Seattle",
    "region": "WA",
    "country": "USA",
    "postalCode": "98121",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "attention": "Billing manager",
    "email": "[email protected]",
    "type": "shipping",
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    }
  },
  "taxCode": "FR1000",
  "isPickup": true,
  "locationNumber": 15,
  "altPickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "[email protected]"
  },
  "pickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "[email protected]"
  },
  "warehouseId": "XYZ-1234",
  "storeId": "ABC-123",
  "shippingCost": 150.25,
  "shippingMethodId": "dfsae-2d32113-32lpdd",
  "shippingDiscount": 150.25,
  "shippingMethodName": "Express Delivery"
}
'

{
  "id": "fef78121-bee3-4448-bf1c-d5b5461dbda2",
  "createdAt": "2022-09-06T14:07:17.000Z",
  "updatedAt": "2022-09-06T14:07:17.000Z",
  "address": {
    "addressLine1": "123 Main St.",
    "city": "Seattle",
    "region": "WA",
    "country": "USA",
    "postalCode": "98121",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "attention": "Billing manager",
    "email": "[email protected]",
    "type": "shipping",
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    }
  },
  "type": "SHIP_TO_ADDRESS",
  "taxCode": "FR1000",
  "isPickup": true,
  "altPickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "[email protected]"
  },
  "pickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "[email protected]"
  },
  "warehouseId": "XYZ-1234",
  "storeId": "ABC-123",
  "shippingCost": 150.25,
  "shippingMethodId": "dfsae-2d32113-32lpdd",
  "shippingDiscount": 150.25,
  "shippingMethodName": "Express Delivery"
}

POST

carts

{cartId}

shipping-details

Create shipping details

curl --request POST \
  --url https://api.fabric.inc/v3/carts/{cartId}/shipping-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "type": "SHIP_TO_ADDRESS",
  "address": {
    "addressLine1": "123 Main St.",
    "city": "Seattle",
    "region": "WA",
    "country": "USA",
    "postalCode": "98121",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "attention": "Billing manager",
    "email": "[email protected]",
    "type": "shipping",
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    }
  },
  "taxCode": "FR1000",
  "isPickup": true,
  "locationNumber": 15,
  "altPickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "[email protected]"
  },
  "pickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "[email protected]"
  },
  "warehouseId": "XYZ-1234",
  "storeId": "ABC-123",
  "shippingCost": 150.25,
  "shippingMethodId": "dfsae-2d32113-32lpdd",
  "shippingDiscount": 150.25,
  "shippingMethodName": "Express Delivery"
}
'

{
  "id": "fef78121-bee3-4448-bf1c-d5b5461dbda2",
  "createdAt": "2022-09-06T14:07:17.000Z",
  "updatedAt": "2022-09-06T14:07:17.000Z",
  "address": {
    "addressLine1": "123 Main St.",
    "city": "Seattle",
    "region": "WA",
    "country": "USA",
    "postalCode": "98121",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "attention": "Billing manager",
    "email": "[email protected]",
    "type": "shipping",
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    }
  },
  "type": "SHIP_TO_ADDRESS",
  "taxCode": "FR1000",
  "isPickup": true,
  "altPickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "[email protected]"
  },
  "pickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "[email protected]"
  },
  "warehouseId": "XYZ-1234",
  "storeId": "ABC-123",
  "shippingCost": 150.25,
  "shippingMethodId": "dfsae-2d32113-32lpdd",
  "shippingDiscount": 150.25,
  "shippingMethodName": "Express Delivery"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id

string

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id

string

Unique request ID

Path Parameters

cartId

string

required

Cart ID

Example:

"b8a64b52-dab4-8137-8d6a-f2c2337abc1"

Body

application/json

Request body containing shipping details to be created

Request body to create shipping details

type

string

required

Shipping type

Example:

"SHIP_TO_ADDRESS"

address

object

Shipping address

Show child attributes

address.addressLine1

string

required

Address line 1

Example:

"123 Main St."

address.city

string

required

City

Example:

"Seattle"

address.region

string

required

Region or state

Example:

"WA"

address.country

string

required

Country (can be full name, or ISO 3166-1 alpha-2 or alpha-3 code)

Example:

"USA"

address.postalCode

string

required

Postal or ZIP code

Example:

"98121"

address.addressLine2

string | null

Address line 2

Example:

"Suite 100"

address.addressLine3

string | null

Address line 3

Example:

"Seventh floor"

address.addressLine4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

address.attention

string | null

Address recipient

Example:

"Billing manager"

address.email

string | null

Receiver's email address

Example:

"[email protected]"

address.type

string | null

Address type

Example:

"shipping"

address.name

string

Recipient's name

Example:

"Pat E Kake"

address.phone

object

Recipient's phone number and type

Show child attributes

address.phone.number

string

required

Phone number

Example:

"123-456-7899"

address.phone.type

string | null

Phone type

Example:

"MOBILE"

taxCode

string | null

Shipping tax code

Example:

"FR1000"

isPickup

boolean

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

Example:

true

locationNumber

integer<int32>

Number of location where item is to be picked up

Example:

15

altPickupPerson

object

Alternative pickup person

Show child attributes

altPickupPerson.name

string

Person's full name

Example:

"Pat E Kake"

altPickupPerson.phone

object

Phone number details

Show child attributes

altPickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

altPickupPerson.phone.type

string | null

Phone type

Example:

"MOBILE"

altPickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

pickupPerson

object

Designated pickup person

Show child attributes

pickupPerson.name

string

Person's full name

Example:

"Pat E Kake"

pickupPerson.phone

object

Phone number details

Show child attributes

pickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

pickupPerson.phone.type

string | null

Phone type

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"

shippingCost

number<double>

Shipping cost

Example:

150.25

shippingMethodId

string

Shipping method ID

Example:

"dfsae-2d32113-32lpdd"

shippingDiscount

number<double>

Discount amount

Example:

150.25

shippingMethodName

string | null

Shipping method name

Example:

"Express Delivery"

Response

Created

Shipping Details

string

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

createdAt

string<date-time>

Time shipping detail was created

Example:

"2022-09-06T14:07:17.000Z"

updatedAt

string<date-time>

Time shipping detail was last updated

Example:

"2022-09-06T14:07:17.000Z"

address

object

Shipping address

Show child attributes

address.addressLine1

string

required

Address line 1

Example:

"123 Main St."

address.city

string

required

City

Example:

"Seattle"

address.region

string

required

Region or state

Example:

"WA"

address.country

string

required

Country (can be full name, or ISO 3166-1 alpha-2 or alpha-3 code)

Example:

"USA"

address.postalCode

string

required

Postal or ZIP code

Example:

"98121"

address.addressLine2

string | null

Address line 2

Example:

"Suite 100"

address.addressLine3

string | null

Address line 3

Example:

"Seventh floor"

address.addressLine4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

address.attention

string | null

Address recipient

Example:

"Billing manager"

address.email

string | null

Receiver's email address

Example:

"[email protected]"

address.type

string | null

Address type

Example:

"shipping"

address.name

string

Recipient's name

Example:

"Pat E Kake"

address.phone

object

Recipient's phone number and type

Show child attributes

address.phone.number

string

required

Phone number

Example:

"123-456-7899"

address.phone.type

string | null

Phone type

Example:

"MOBILE"

type

string

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

string

Person's full name

Example:

"Pat E Kake"

altPickupPerson.phone

object

Phone number details

Show child attributes

altPickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

altPickupPerson.phone.type

string | null

Phone type

Example:

"MOBILE"

altPickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

pickupPerson

object

Designated pickup person

Show child attributes

pickupPerson.name

string

Person's full name

Example:

"Pat E Kake"

pickupPerson.phone

object

Phone number details

Show child attributes

pickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

pickupPerson.phone.type

string | null

Phone type

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"

shippingCost

number<double>

Shipping cost

Example:

150.25

shippingMethodId

string

Shipping method ID

Example:

"dfsae-2d32113-32lpdd"

shippingDiscount

number<double>

Discount amount

Example:

150.25

shippingMethodName

string | null

Shipping method name

Example:

"Express Delivery"

⌘I

Getting Started

Getting Started with Copilot

Getting started with fabric APIs

API Authentication

Create shipping details

Authorizations

Headers

Path Parameters

Body

Response