POST
/
carts
/
{cartId}
/
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 '{
  "address": {
    "addressLine1": "123 Main St.",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "city": "Seattle",
    "region": "WA",
    "country": "USA",
    "postalCode": "98121",
    "attention": "Billing manager",
    "email": "test@example.com",
    "type": "shipping",
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    }
  },
  "type": "SHIP_TO_ADDRESS",
  "taxCode": "FR1000",
  "isPickup": true,
  "locationNumber": 15,
  "altPickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "test@example.com"
  },
  "pickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "test@example.com"
  },
  "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.",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "city": "Seattle",
    "region": "WA",
    "country": "USA",
    "postalCode": "98121",
    "attention": "Billing manager",
    "email": "test@example.com",
    "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": "test@example.com"
  },
  "pickupPerson": {
    "name": "Pat E Kake",
    "phone": {
      "number": "123-456-7899",
      "type": "MOBILE"
    },
    "email": "test@example.com"
  },
  "warehouseId": "XYZ-1234",
  "storeId": "ABC-123",
  "shippingCost": 150.25,
  "shippingMethodId": "dfsae-2d32113-32lpdd",
  "shippingDiscount": 150.25,
  "shippingMethodName": "Express Delivery"
}

Authorizations

Authorization
string
headerrequired

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

Headers

x-fabric-tenant-id
string
required

Merchant's 24-character tenant ID

x-fabric-channel-id
string

Sales channel ID

x-fabric-request-id
string

Unique request ID

Path Parameters

cartId
string
required

Cart ID

Body

application/json
address
object

Shipping address

type
string
required

Shipping type

taxCode
string | null

Shipping tax code

isPickup
boolean

true: Item is set for pickup<br />false: Item is set for delivery

locationNumber
integer

Number of location where item is to be picked up

altPickupPerson
object

Alternative pickup person

pickupPerson
object

Designated pickup person

warehouseId
string | null

Warehouse ID

storeId
string | null

Store ID

shippingCost
number

Shipping cost

shippingMethodId
string

Shipping method ID

shippingDiscount
number

Discount amount

shippingMethodName
string | null

Shipping method name

Response

201 - application/json
id
string

Shipping details ID

createdAt
string

Time shipping detail was created

updatedAt
string

Time shipping detail was last updated

address
object

Shipping address

type
string

Shipping type

taxCode
string | null

Shipping tax code

isPickup
boolean

true: Item is set for pickup<br />false: Item is set for delivery

altPickupPerson
object

Alternative pickup person

pickupPerson
object

Designated pickup person

warehouseId
string | null

Warehouse ID

storeId
string | null

Store ID

shippingCost
number

Shipping cost

shippingMethodId
string

Shipping method ID

shippingDiscount
number

Discount amount

shippingMethodName
string | null

Shipping method name