Update line item shipping details

curl --request PUT \
  --url https://api.fabric.inc/v3/carts/{cartId}/line-items/{lineItemId}/shipping-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "shippingDetailId": "fef78121-bee3-4448-bf1c-d5b5461dbda2"
}
'

{
  "id": "12gved0f-7645-40cb-y7b0-167f8bggdb3z",
  "itemId": "<unknown>",
  "position": 1,
  "name": "Varnet Garden Light Kit",
  "sku": "16B2GS8LD5FDS",
  "productAttributes": [
    {
      "name": "gift wrapping (small)",
      "value": "true",
      "attributeId": "60c2a358eb2ec30008ae70a1",
      "description": "Gift wrapping for a small package",
      "mapping": "ITEM",
      "type": "GIFT",
      "price": 10,
      "level": "order"
    }
  ],
  "createdAt": "2022-09-06T14:07:17.000Z",
  "updatedAt": "2022-09-06T14:07:17.000Z",
  "quantity": 15,
  "priceListId": 108674,
  "isActive": true,
  "price": "<unknown>",
  "discounts": [
    "<unknown>"
  ],
  "groups": [
    "61d38e117162b7dba69c3d6d"
  ],
  "attributes": {
    "productFamily": "Laptop computers"
  },
  "channel": "12",
  "isPickup": true,
  "warehouseId": "XYZ-1234",
  "shippingDetails": {
    "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"
  },
  "fulfillment": {
    "type": "WEB_SDD",
    "networkCode": "ShipToHome",
    "channelId": "12",
    "inventoryType": "availableToPurchase",
    "inventory": {
      "inventoryId": "723910d81723",
      "sku": "SKU1",
      "itemId": 12345,
      "locationNumber": 12345,
      "region": "North America",
      "channelId": "channel_xyz",
      "vendorId": "vendor1",
      "createdAt": "2022-08-01T18:03:28.483971941Z",
      "updatedAt": "2022-08-01T20:03:28.483971941Z",
      "leadTime": "5 days",
      "type": "primary",
      "hasInfiniteInventory": false,
      "backorderShipmentAt": "2022-08-01T20:03:28.483971941Z",
      "preorderShipmentAt": "2022-08-01T20:03:28.483971941Z",
      "backorderLimit": 50,
      "preorderLimit": 40,
      "safetyStock": 10,
      "lowStock": 10,
      "networkCode": "ShipToHome",
      "counters": {
        "onHand": 100,
        "allocated": 10,
        "shipped": 20
      },
      "customAttributes": {
        "isBopis": true
      },
      "networkCounters": {
        "softReserve": 10
      },
      "virtualCounters": {
        "availableToPurchase": 60
      }
    }
  },
  "fees": [
    {
      "feeId": "73bc09d0-874a-4c3d-84d0-df1670d03578",
      "name": "gift",
      "type": "gift_wrap",
      "amount": 10.5,
      "attributes": {
        "from": "sam"
      }
    }
  ],
  "adjustments": [
    {
      "id": "c695af14-5e33-402c-9d8d-71edcf4856a8",
      "amount": 60.5,
      "reason": "CSR Adjustment",
      "attributes": {
        "productFamily": "Laptop computers"
      },
      "createdAt": "2022-09-06T14:07:17.000Z",
      "updatedAt": "2022-09-06T14:07:17.000Z"
    }
  ]
}

PUT

carts

{cartId}

line-items

{lineItemId}

shipping-details

Update line item shipping details

curl --request PUT \
  --url https://api.fabric.inc/v3/carts/{cartId}/line-items/{lineItemId}/shipping-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "shippingDetailId": "fef78121-bee3-4448-bf1c-d5b5461dbda2"
}
'

{
  "id": "12gved0f-7645-40cb-y7b0-167f8bggdb3z",
  "itemId": "<unknown>",
  "position": 1,
  "name": "Varnet Garden Light Kit",
  "sku": "16B2GS8LD5FDS",
  "productAttributes": [
    {
      "name": "gift wrapping (small)",
      "value": "true",
      "attributeId": "60c2a358eb2ec30008ae70a1",
      "description": "Gift wrapping for a small package",
      "mapping": "ITEM",
      "type": "GIFT",
      "price": 10,
      "level": "order"
    }
  ],
  "createdAt": "2022-09-06T14:07:17.000Z",
  "updatedAt": "2022-09-06T14:07:17.000Z",
  "quantity": 15,
  "priceListId": 108674,
  "isActive": true,
  "price": "<unknown>",
  "discounts": [
    "<unknown>"
  ],
  "groups": [
    "61d38e117162b7dba69c3d6d"
  ],
  "attributes": {
    "productFamily": "Laptop computers"
  },
  "channel": "12",
  "isPickup": true,
  "warehouseId": "XYZ-1234",
  "shippingDetails": {
    "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"
  },
  "fulfillment": {
    "type": "WEB_SDD",
    "networkCode": "ShipToHome",
    "channelId": "12",
    "inventoryType": "availableToPurchase",
    "inventory": {
      "inventoryId": "723910d81723",
      "sku": "SKU1",
      "itemId": 12345,
      "locationNumber": 12345,
      "region": "North America",
      "channelId": "channel_xyz",
      "vendorId": "vendor1",
      "createdAt": "2022-08-01T18:03:28.483971941Z",
      "updatedAt": "2022-08-01T20:03:28.483971941Z",
      "leadTime": "5 days",
      "type": "primary",
      "hasInfiniteInventory": false,
      "backorderShipmentAt": "2022-08-01T20:03:28.483971941Z",
      "preorderShipmentAt": "2022-08-01T20:03:28.483971941Z",
      "backorderLimit": 50,
      "preorderLimit": 40,
      "safetyStock": 10,
      "lowStock": 10,
      "networkCode": "ShipToHome",
      "counters": {
        "onHand": 100,
        "allocated": 10,
        "shipped": 20
      },
      "customAttributes": {
        "isBopis": true
      },
      "networkCounters": {
        "softReserve": 10
      },
      "virtualCounters": {
        "availableToPurchase": 60
      }
    }
  },
  "fees": [
    {
      "feeId": "73bc09d0-874a-4c3d-84d0-df1670d03578",
      "name": "gift",
      "type": "gift_wrap",
      "amount": 10.5,
      "attributes": {
        "from": "sam"
      }
    }
  ],
  "adjustments": [
    {
      "id": "c695af14-5e33-402c-9d8d-71edcf4856a8",
      "amount": 60.5,
      "reason": "CSR Adjustment",
      "attributes": {
        "productFamily": "Laptop computers"
      },
      "createdAt": "2022-09-06T14:07:17.000Z",
      "updatedAt": "2022-09-06T14:07:17.000Z"
    }
  ]
}

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"

lineItemId

string

required

Line item ID

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

Body

application/json

A sample request to add shipping details to a line item in the cart.

Request body used to update line item shipping details

shippingDetailId

string

required

Unique shipping detail identifier

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

Response

Line item details

string | null

Line item ID

Example:

"12gved0f-7645-40cb-y7b0-167f8bggdb3z"

itemId

any

position

integer<int32>

Line item position number (starts at 1)

Required range: x >= 1

Example:

1

name

string | null

Line item name

Example:

"Varnet Garden Light Kit"

sku

string

Line item SKU

Example:

"16B2GS8LD5FDS"

productAttributes

object[] | null

Additional line item options

Show child attributes

productAttributes.name

string

required

Attribute name

Example:

"gift wrapping (small)"

productAttributes.value

string | null

required

Attribute value

Example:

"true"

productAttributes.attributeId

string

Attribute ID

Example:

"60c2a358eb2ec30008ae70a1"

productAttributes.description

string | null

Attribute description

Example:

"Gift wrapping for a small package"

productAttributes.mapping

string | null

Attribute mapping

Example:

"ITEM"

productAttributes.type

string | null

Attribute type

Example:

"GIFT"

productAttributes.price

number<double> | null

Attribute price

Example:

10

productAttributes.level

string | null

Attribute level

Example:

"order"

createdAt

string<date-time>

Time line item was created

Example:

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

updatedAt

string<date-time>

Time line item was last updated

Example:

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

quantity

integer<int32>

Line item quantity

Example:

15

priceListId

integer<int32> | null

Line item price list ID

Example:

108674

isActive

boolean | null

true: Item is active
false: Item is inactive

Example:

true

price

any

Individual line item price

discounts

any[]

Individual line item discount

groups

string[] | null

Group or category ID to which line item belongs

attributes

object

Attributes passed by caller

Show child attributes

attributes.{key}

Example:

{ "productFamily": "Laptop computers" }

channel

string

Sales channel

Example:

"12"

isPickup

boolean

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

Example:

true

warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

shippingDetails

object

Shipping details

Show child attributes

shippingDetails.id

string

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

shippingDetails.createdAt

string<date-time>

Time shipping detail was created

Example:

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

shippingDetails.updatedAt

string<date-time>

Time shipping detail was last updated

Example:

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

shippingDetails.address

object

Shipping address

Show child attributes

shippingDetails.address.addressLine1

string

required

Address line 1

Example:

"123 Main St."

shippingDetails.address.city

string

required

City

Example:

"Seattle"

shippingDetails.address.region

string

required

Region or state

Example:

"WA"

shippingDetails.address.country

string

required

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

Example:

"USA"

shippingDetails.address.postalCode

string

required

Postal or ZIP code

Example:

"98121"

shippingDetails.address.addressLine2

string | null

Address line 2

Example:

"Suite 100"

shippingDetails.address.addressLine3

string | null

Address line 3

Example:

"Seventh floor"

shippingDetails.address.addressLine4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

shippingDetails.address.attention

string | null

Address recipient

Example:

"Billing manager"

shippingDetails.address.email

string | null

Receiver's email address

Example:

"[email protected]"

shippingDetails.address.type

string | null

Address type

Example:

"shipping"

shippingDetails.address.name

string

Recipient's name

Example:

"Pat E Kake"

shippingDetails.address.phone

object

Recipient's phone number and type

Show child attributes

shippingDetails.address.phone.number

string

required

Phone number

Example:

"123-456-7899"

shippingDetails.address.phone.type

string | null

Phone type

Example:

"MOBILE"

shippingDetails.type

string

Shipping type

Example:

"SHIP_TO_ADDRESS"

shippingDetails.taxCode

string | null

Shipping tax code

Example:

"FR1000"

shippingDetails.isPickup

boolean

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

Example:

true

shippingDetails.altPickupPerson

object

Alternative pickup person

Show child attributes

shippingDetails.altPickupPerson.name

string

Person's full name

Example:

"Pat E Kake"

shippingDetails.altPickupPerson.phone

object

Phone number details

Show child attributes

shippingDetails.altPickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

shippingDetails.altPickupPerson.phone.type

string | null

Phone type

Example:

"MOBILE"

shippingDetails.altPickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

shippingDetails.pickupPerson

object

Designated pickup person

Show child attributes

shippingDetails.pickupPerson.name

string

Person's full name

Example:

"Pat E Kake"

shippingDetails.pickupPerson.phone

object

Phone number details

Show child attributes

shippingDetails.pickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

shippingDetails.pickupPerson.phone.type

string | null

Phone type

Example:

"MOBILE"

shippingDetails.pickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

shippingDetails.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

shippingDetails.storeId

string | null

Store ID

Example:

"ABC-123"

shippingDetails.shippingCost

number<double>

Shipping cost

Example:

150.25

shippingDetails.shippingMethodId

string

Shipping method ID

Example:

"dfsae-2d32113-32lpdd"

shippingDetails.shippingDiscount

number<double>

Discount amount

Example:

150.25

shippingDetails.shippingMethodName

string | null

Shipping method name

Example:

"Express Delivery"

fulfillment

object

The fulfillment details. Fulfillment details

Show child attributes

fulfillment.type

string | null

Fulfillment type

Example:

"WEB_SDD"

fulfillment.networkCode

string | null

Inventory network code

Example:

"ShipToHome"

fulfillment.channelId

string

Sales channel

Example:

"12"

fulfillment.inventoryType

string

default:availableToPurchase

Inventory type - a classifier attribute that provides flexibility to define inventory types

Example:

"availableToPurchase"

fulfillment.inventory

object

The inventory response.

Show child attributes

fulfillment.inventory.inventoryId

string

System-generated inventory ID. This ID is generated during inventory creation.

Example:

"723910d81723"

fulfillment.inventory.sku

string

Product SKU (Stock Keeping Unit) identifier. It serves as the primary reference key for the inventory and provides uniqueness to the item.

Example:

"SKU1"

fulfillment.inventory.itemId

integer<int32>

Merchant-defined item ID whose inventory is created or updated. If omitted, fabric Inventory service generates the itemId. If you choose to use the itemId in your environment, you must include it in all inventory Write requests.

Example:

12345

fulfillment.inventory.locationNumber

integer<int32>

Represents the warehouse or store location where the inventory is stored. It's recommended to link locationNumber to the corresponding value in the fabric Locations service.

Example:

12345

fulfillment.inventory.region

string

Region where inventory is managed

Example:

"North America"

fulfillment.inventory.channelId

string

Example:

"channel_xyz"

fulfillment.inventory.vendorId

string

ID of the vendor who will replenish the inventory for the retailer

Example:

"vendor1"

fulfillment.inventory.createdAt

string<date-time>

Time of inventory creation

Example:

"2022-08-01T18:03:28.483971941Z"

fulfillment.inventory.updatedAt

string<date-time>

Time when inventory was last updated

Example:

"2022-08-01T20:03:28.483971941Z"

fulfillment.inventory.leadTime

string

Time between when an order is placed to replenish inventory and when the order is received at warehouse

Example:

"5 days"

fulfillment.inventory.type

string

Inventory type - a classifier attribute that provides flexibility to define inventory types

Example:

"primary"

fulfillment.inventory.hasInfiniteInventory

boolean

default:false

Infinite inventory flag.
true: Inventory can be used any number of times and doesn't have any consumption limit.
false: Inventory can't be used infinitely, and has a consumption limit.

Example:

false

fulfillment.inventory.backorderShipmentAt

string<date-time>

Time when backorder is shipped

Example:

"2022-08-01T20:03:28.483971941Z"

fulfillment.inventory.preorderShipmentAt

string<date-time>

Time when preorder is shipped

Example:

"2022-08-01T20:03:28.483971941Z"

fulfillment.inventory.backorderLimit

integer<int32>

Maximum restock inventory quantity

Example:

50

fulfillment.inventory.preorderLimit

integer<int32>

Maximum first-shipping inventory quantity

Example:

40

fulfillment.inventory.safetyStock

integer<int32>

Reserved inventory quantity at the location

Example:

10

fulfillment.inventory.lowStock

integer<int32>

Inventory quantity below which consumer service wants to be alerted as low stock at the location

Example:

10

fulfillment.inventory.networkCode

string

Code of the network to which the inventory belongs

Example:

"ShipToHome"

fulfillment.inventory.counters

object

Merchant-defined inventory counter (also known as inventory position)

Show child attributes

fulfillment.inventory.counters.{key}

integer<int32>

Merchant-defined inventory counter (also known as inventory position)

Example:

{
  "onHand": 100,
  "allocated": 10,
  "shipped": 20
}

fulfillment.inventory.customAttributes

object

Placeholder for additional info

Show child attributes

fulfillment.inventory.customAttributes.{key}

string

Placeholder for additional info

Example:

"{\"isBopis\":true}"

Example:

{ "isBopis": true }

fulfillment.inventory.networkCounters

object

Indicates inventory positions at network

Show child attributes

fulfillment.inventory.networkCounters.{key}

integer<int32>

Indicates inventory positions at network

Example:

{ "softReserve": 10 }

fulfillment.inventory.virtualCounters

object

Virtual counters are calculated at run time from counters

Show child attributes

fulfillment.inventory.virtualCounters.{key}

integer<int32>

Virtual counters are calculated at run time from counters

Example:

{ "availableToPurchase": 60 }

fees

object[] | null

Show child attributes

fees.feeId

string

System-generated fee ID, in UUID format. While creating a cart or line item with fee, fabric generates this ID for the specified fee.

Example:

"73bc09d0-874a-4c3d-84d0-df1670d03578"

fees.name

string | null

Attribute for which fee is applied

Example:

"gift"

fees.type

string | null

Fee type

Example:

"gift_wrap"

fees.amount

number<double>

default:0

Fee amount

Example:

10.5

fees.attributes

object

Placeholder for additional information in key:value pairs

Show child attributes

fees.attributes.{key}

Example:

{ "from": "sam" }

adjustments

object[] | null

Show child attributes

adjustments.id

string

required

Price adjustment ID; it identifies a single price adjustment object within the price adjustments array.

Example:

"c695af14-5e33-402c-9d8d-71edcf4856a8"

adjustments.amount

number<double>

required

Amount by which the line item's total amount or the specified cart's total amount is adjusted

Example:

60.5

adjustments.reason

string

required

Price adjustment reason

Example:

"CSR Adjustment"

adjustments.attributes

object

Placeholder for additional information

Show child attributes

adjustments.attributes.{key}

Example:

{ "productFamily": "Laptop computers" }

adjustments.createdAt

string<date-time>

Time cart was created

Example:

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

adjustments.updatedAt

string<date-time>

Time cart was last updated

Example:

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

⌘I

Getting Started

Getting Started with Copilot

Getting started with fabric APIs

API Authentication

Update line item shipping details

Authorizations

Headers

Path Parameters

Body

Response