Update a line item

Through this endpoint, you can update line item details within the cart, including adjustments to quantity and price.

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

lineItemId

string

required

Line item ID

Body

application/json

Item information to be updated

itemId

any

required

quantity

integer

required

Updated quantity of line items in cart

attributes

object | null

Placeholder to add additional information

Show child attributes

attributes.{key}

fees

object[] | null

Show child attributes

fees.amount

number

default:

0

Fee amount

fees.attributes

object | null

Placeholder for additional information in key:value pairs

Show child attributes

fees.attributes.{key}

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.

fees.name

string | null

Attribute for which fee is applied

fees.type

string | null

Fee type

fulfillment

object | null

Fulfillment request details

Show child attributes

fulfillment.channelId

string

Sales channel

fulfillment.inventoryType

string

default:

availableToPurchase

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

fulfillment.networkCode

string | null

Inventory network code

fulfillment.type

string | null

Fulfillment type

priceListId

integer | null

Item price list ID

sku

string | null

Item SKU

Response

200 - application/json

Line item details

adjustments

object[] | null

Show child attributes

adjustments.amount

number

required

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

adjustments.id

string

required

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

adjustments.reason

string

required

Price adjustment reason

adjustments.attributes

object | null

Placeholder for additional information

Show child attributes

adjustments.attributes.{key}

adjustments.createdAt

string

Time cart was created

adjustments.updatedAt

string

Time cart was last updated

attributes

object | null

Attributes passed by caller

Show child attributes

attributes.{key}

channel

string

Sales channel

createdAt

string

Time line item was created

discounts

any[]

Individual line item discount

fees

object[] | null

Show child attributes

fees.amount

number

default:

0

Fee amount

fees.attributes

object | null

Placeholder for additional information in key:value pairs

Show child attributes

fees.attributes.{key}

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.

fees.name

string | null

Attribute for which fee is applied

fees.type

string | null

Fee type

fulfillment

object | null

The fulfillment details.

Show child attributes

fulfillment.channelId

string

Sales channel

fulfillment.inventory

object | null

The inventory response.

Show child attributes

fulfillment.inventory.backorderLimit

integer

Maximum restock inventory quantity

fulfillment.inventory.backorderShipmentAt

string

Time when backorder is shipped

fulfillment.inventory.channelId

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.; identifies business operations location.

fulfillment.inventory.counters

object

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

Show child attributes

fulfillment.inventory.counters.{key}

integer

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

fulfillment.inventory.createdAt

string

Time of inventory creation

fulfillment.inventory.customAttributes

object

Placeholder for additional info

Show child attributes

fulfillment.inventory.customAttributes.{key}

string

Placeholder for additional info

fulfillment.inventory.hasInfiniteInventory

boolean

default:

false

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

fulfillment.inventory.inventoryId

string

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

fulfillment.inventory.itemId

integer

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.

fulfillment.inventory.leadTime

string

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

fulfillment.inventory.locationNumber

integer

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.

fulfillment.inventory.lowStock

integer

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

fulfillment.inventory.networkCode

string

Code of the network to which the inventory belongs

fulfillment.inventory.networkCounters

object

Indicates inventory positions at network

Show child attributes

fulfillment.inventory.networkCounters.{key}

integer

Indicates inventory positions at network

fulfillment.inventory.preorderLimit

integer

Maximum first-shipping inventory quantity

fulfillment.inventory.preorderShipmentAt

string

Time when preorder is shipped

fulfillment.inventory.region

string

Region where inventory is managed

fulfillment.inventory.safetyStock

integer

Reserved inventory quantity at the location

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.

fulfillment.inventory.type

string

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

fulfillment.inventory.updatedAt

string

Time when inventory was last updated

fulfillment.inventory.vendorId

string

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

fulfillment.inventory.virtualCounters

object

Virtual counters are calculated at run time from counters

Show child attributes

fulfillment.inventory.virtualCounters.{key}

integer

Virtual counters are calculated at run time from counters

fulfillment.inventoryType

string

default:

availableToPurchase

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

fulfillment.networkCode

string | null

Inventory network code

fulfillment.type

string | null

Fulfillment type

groups

string[] | null

id

string | null

Line item ID

isActive

boolean | null

true: Item is active<br />false: Item is inactive

isPickup

boolean

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

itemId

any

name

string | null

Line item name

position

integer

Line item position number (starts at 1)

Required range: x > 1

price

any | null

Individual line item price

priceListId

integer | null

Line item price list ID

productAttributes

object[] | null

Additional line item options

Show child attributes

productAttributes.name

string

required

Attribute name

productAttributes.value

string | null

required

Attribute value

productAttributes.attributeId

string

Attribute ID

productAttributes.description

string | null

Attribute description

productAttributes.level

string | null

Attribute level

productAttributes.mapping

string | null

Attribute mapping

productAttributes.price

number | null

Attribute price

productAttributes.type

string | null

Attribute type

quantity

integer

Line item quantity

shippingDetails

object

Shipping details

Show child attributes

shippingDetails.address

object

Shipping address

Show child attributes

shippingDetails.address.addressLine1

string

required

Address line 1

shippingDetails.address.city

string

required

City

shippingDetails.address.country

string

required

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

shippingDetails.address.postalCode

string

required

Postal or ZIP code

shippingDetails.address.region

string

required

Region or state

shippingDetails.address.addressLine2

string | null

Address line 2

shippingDetails.address.addressLine3

string | null

Address line 3

shippingDetails.address.addressLine4

string | null

Address line 4

shippingDetails.address.attention

string | null

Address recipient

shippingDetails.address.email

string | null

Receiver's email address

shippingDetails.address.name

string

Recipient's name

shippingDetails.address.phone

object

Recipient's phone number and type

Show child attributes

shippingDetails.address.phone.number

string

required

Phone number

shippingDetails.address.phone.type

string | null

Phone type

shippingDetails.address.type

string | null

Address type

shippingDetails.altPickupPerson

object

Alternative pickup person

Show child attributes

shippingDetails.altPickupPerson.email

string | null

Receiver's email address

shippingDetails.altPickupPerson.name

string

Person's full name

shippingDetails.altPickupPerson.phone

object

Phone number details

Show child attributes

shippingDetails.altPickupPerson.phone.number

string

required

Phone number

shippingDetails.altPickupPerson.phone.type

string | null

Phone type

shippingDetails.createdAt

string

Time shipping detail was created

shippingDetails.id

string

Shipping details ID

shippingDetails.isPickup

boolean

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

shippingDetails.pickupPerson

object

Designated pickup person

Show child attributes

shippingDetails.pickupPerson.email

string | null

Receiver's email address

shippingDetails.pickupPerson.name

string

Person's full name

shippingDetails.pickupPerson.phone

object

Phone number details

Show child attributes

shippingDetails.pickupPerson.phone.number

string

required

Phone number

shippingDetails.pickupPerson.phone.type

string | null

Phone type

shippingDetails.shippingCost

number

Shipping cost

shippingDetails.shippingDiscount

number

Discount amount

shippingDetails.shippingMethodId

string

Shipping method ID

shippingDetails.shippingMethodName

string | null

Shipping method name

shippingDetails.storeId

string | null

Store ID

shippingDetails.taxCode

string | null

Shipping tax code

shippingDetails.type

string

Shipping type

shippingDetails.updatedAt

string

Time shipping detail was last updated

shippingDetails.warehouseId

string | null

Warehouse ID

sku

string

Line item SKU

updatedAt

string

Time line item was last updated

warehouseId

string | null

Warehouse ID