Create a line item

Add an item to specified cart. If the cart doesn’t exist, create it and add the item.

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 for adding line item to cart

Line items to add to cart

itemId

any

required

quantity

integer

required

Number of line items in cart

Example:

1

sku

string | null

Item SKU

Example:

"16B2GS8LD5FDS"

priceListId

integer | null

Item price list ID

Example:

100000

attributes

object | null

Additional data passed by the caller

Show child attributes

attributes.{key}

Example:

{ "productFamily": "Laptop computers" }

fulfillment

object | null

Fulfillment request 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"

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

default:

0

Fee amount

Example:

10.5

fees.attributes

object | null

Placeholder for additional information in key:value pairs

Show child attributes

fees.attributes.{key}

Example:

{ "from": "sam" }

Response

201

application/json

Created

Line item details

id

string | null

Line item ID

Example:

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

itemId

any

position

integer

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

Product attribute as defined within Product Catalog.

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 | null

Attribute price

Example:

10

productAttributes.level

string | null

Attribute level

Example:

"order"

createdAt

string

Time line item was created

Example:

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

updatedAt

string

Time line item was last updated

Example:

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

quantity

integer

Line item quantity

Example:

15

priceListId

integer | null

Line item price list ID

Example:

108674

isActive

boolean | null

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

Example:

true

price

any | null

Individual line item price

discounts

any[]

Individual line item discount

groups

string[] | null

Group or category ID to which line item belongs

attributes

object | null

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<br />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

Time shipping detail was created

Example:

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

shippingDetails.updatedAt

string

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:

"[e-mail]"

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<br />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:

"[e-mail]"

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:

"[e-mail]"

shippingDetails.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

shippingDetails.storeId

string | null

Store ID

Example:

"ABC-123"

shippingDetails.shippingCost

number

Shipping cost

Example:

150.25

shippingDetails.shippingMethodId

string

Shipping method ID

Example:

"dfsae-2d32113-32lpdd"

shippingDetails.shippingDiscount

number

Discount amount

Example:

150.25

shippingDetails.shippingMethodName

string | null

Shipping method name

Example:

"Express Delivery"

fulfillment

object | null

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 | null

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

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

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

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.

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

Time of inventory creation

Example:

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

fulfillment.inventory.updatedAt

string

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.<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.

Example:

false

fulfillment.inventory.backorderShipmentAt

string

Time when backorder is shipped

Example:

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

fulfillment.inventory.preorderShipmentAt

string

Time when preorder is shipped

Example:

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

fulfillment.inventory.backorderLimit

integer

Maximum restock inventory quantity

Example:

50

fulfillment.inventory.preorderLimit

integer

Maximum first-shipping inventory quantity

Example:

40

fulfillment.inventory.safetyStock

integer

Reserved inventory quantity at the location

Example:

10

fulfillment.inventory.lowStock

integer

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

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

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

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

default:

0

Fee amount

Example:

10.5

fees.attributes

object | null

Placeholder for additional information in key:value pairs

Show child attributes

fees.attributes.{key}

Example:

{ "from": "sam" }

adjustments

object[] | null

Price adjustment details for the specified line item or the specified cart

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

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 | null

Placeholder for additional information

Show child attributes

adjustments.attributes.{key}

Example:

{ "productFamily": "Laptop computers" }

adjustments.createdAt

string

Time cart was created

Example:

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

adjustments.updatedAt

string

Time cart was last updated

Example:

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