PUT
/
carts
/
{cartId}
/
shipping-details
/
{shippingDetailId}
curl --request PUT \
  --url https://api.fabric.inc/v3/carts/{cartId}/shipping-details/{shippingDetailId} \
  --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
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"

​
shippingDetailId
string
required

Shipping detail identifier

Example:

"a1b26d22-cad2-6242-a2b4-e3c4282bad4"

Body

application/json
Request body containing shipping details to be updated

Request body to update shipping details

​
type
string
required

Shipping type

Example:

"SHIP_TO_ADDRESS"

​
address
object

Shipping address

​
taxCode
string | null

Shipping tax code

Example:

"FR1000"

​
isPickup
boolean

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

Example:

true

​
locationNumber
integer

Number of location where item is to be picked up

Example:

15

​
altPickupPerson
object

Alternative pickup person

​
pickupPerson
object

Designated pickup person

​
warehouseId
string | null

Warehouse ID

Example:

"XYZ-1234"

​
storeId
string | null

Store ID

Example:

"ABC-123"

​
shippingCost
number

Shipping cost

Example:

150.25

​
shippingMethodId
string

Shipping method ID

Example:

"dfsae-2d32113-32lpdd"

​
shippingDiscount
number

Discount amount

Example:

150.25

​
shippingMethodName
string | null

Shipping method name

Example:

"Express Delivery"

Response

200
application/json
OK

Shipping Details

​
id
string

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

​
createdAt
string

Time shipping detail was created

Example:

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

​
updatedAt
string

Time shipping detail was last updated

Example:

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

​
address
object

Shipping address

​
type
string

Shipping type

Example:

"SHIP_TO_ADDRESS"

​
taxCode
string | null

Shipping tax code

Example:

"FR1000"

​
isPickup
boolean

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

Example:

true

​
altPickupPerson
object

Alternative pickup person

​
pickupPerson
object

Designated pickup person

​
warehouseId
string | null

Warehouse ID

Example:

"XYZ-1234"

​
storeId
string | null

Store ID

Example:

"ABC-123"

​
shippingCost
number

Shipping cost

Example:

150.25

​
shippingMethodId
string

Shipping method ID

Example:

"dfsae-2d32113-32lpdd"

​
shippingDiscount
number

Discount amount

Example:

150.25

​
shippingMethodName
string | null

Shipping method name

Example:

"Express Delivery"

Was this page helpful?