Update line items

PATCH

carts

{cartId}

line-items

curl --request PATCH \
  --url https://api.fabric.inc/v3/carts/{cartId}/line-items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "updateLineItems": [
    {
      "id": "12gved0f-7645-40cb-y7b0-167f8bggdb3z",
      "sku": "13B9CL6WT2SLW",
      "quantity": 2,
      "itemId": 1730902008,
      "priceListId": 100000,
      "attributes": {
        "productFamily": "Laptop computers"
      },
      "fulfillment": {
        "type": "WEB_SDD",
        "networkCode": "ShipToHome",
        "channelId": "12",
        "inventoryType": "availableToPurchase"
      },
      "fees": [
        {
          "feeId": "73bc09d0-874a-4c3d-84d0-df1670d03578",
          "name": "gift",
          "type": "gift_wrap",
          "amount": 10.5,
          "attributes": {
            "from": "sam"
          }
        }
      ],
      "shippingDetailId": "fef78121-bee3-4448-bf1c-d5b5461dbda2"
    }
  ]
}'

{
  "data": [
    {
      "id": "12gved0f-7645-40cb-y7b0-167f8bggdb3z",
      "itemId": 1730902008,
      "position": 1,
      "name": "Varnet Garden Light Kit",
      "sku": "16B2GS8LD5FDS",
      "productAttributes": [
        {
          "attributeId": "60c2a358eb2ec30008ae70a1",
          "name": "gift wrapping (small)",
          "description": "Gift wrapping for a small package",
          "mapping": "ITEM",
          "type": "GIFT",
          "value": "true",
          "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": {
        "sale": 1000.15,
        "cost": 900.15,
        "base": 2000.15,
        "unitPriceWithoutDiscounts": 2000.15,
        "lineTotalWithoutDiscounts": 2000.15,
        "lineTotalWithDiscounts": 2000.15,
        "type": "BASE"
      },
      "discounts": [
        {
          "amount": 100.15,
          "quantity": 1,
          "proratedAmount": 100.15,
          "proratedQuantity": 1,
          "application": 1,
          "promotion": {
            "id": "6197ec46e836ff000952d668",
            "value": 2000.15,
            "groupId": "61a6354d0d70e30009415f16",
            "level": 1,
            "isStackable": true,
            "isAlwaysApplied": true,
            "name": "20% OFF",
            "type": "Coupon",
            "discountType": "AMOUNT_OFF"
          }
        }
      ],
      "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.",
          "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"
      },
      "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"
        }
      ]
    }
  ],
  "error": {
    "prices": [
      {
        "price": {
          "sale": 1000.15,
          "cost": 900.15,
          "base": 2000.15,
          "unitPriceWithoutDiscounts": 2000.15,
          "lineTotalWithoutDiscounts": 2000.15,
          "lineTotalWithDiscounts": 2000.15,
          "type": "BASE"
        },
        "kind": "PROMOTION",
        "channel": "12",
        "position": 1,
        "discounts": [
          {
            "amount": 100.15,
            "quantity": 1,
            "proratedAmount": 100.15,
            "proratedQuantity": 1,
            "application": 1,
            "promotion": {
              "id": "6197ec46e836ff000952d668",
              "value": 2000.15,
              "groupId": "61a6354d0d70e30009415f16",
              "level": 1,
              "isStackable": true,
              "isAlwaysApplied": true,
              "name": "20% OFF",
              "type": "Coupon",
              "discountType": "AMOUNT_OFF"
            }
          }
        ]
      }
    ],
    "promotionErrors": [
      {
        "itemId": 1730902008,
        "sku": "16B2GS8LD5FDS",
        "code": "UNKNOWN_ERROR",
        "detail": "Item is out of stock",
        "position": 1
      }
    ],
    "inventoryErrors": [
      {
        "itemId": 1730902008,
        "sku": "16B2GS8LD5FDS",
        "code": "UNKNOWN_ERROR",
        "detail": "Item is out of stock",
        "position": 1
      }
    ]
  }
}

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

Sample request to update line items of a cart

updateLineItems

object[]

required

Details of the line items to update

Line item details to be updated

updateLineItems.id

string

required

Line item ID

Example:

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

updateLineItems.sku

string

Item SKU

Example:

"13B9CL6WT2SLW"

updateLineItems.quantity

integer

Updated quantity of the line item

Example:

2

updateLineItems.itemId

any

updateLineItems.priceListId

integer

Item price list ID

Example:

100000

updateLineItems.attributes

object

Placeholder to add additional information

Example:

{ "productFamily": "Laptop computers" }

updateLineItems.fulfillment

object | null

Fulfillment request details

updateLineItems.fees

object[]

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

updateLineItems.fees.name

string | null

Attribute for which fee is applied

Example:

"gift"

updateLineItems.fees.type

string | null

Fee type

Example:

"gift_wrap"

updateLineItems.fees.amount

number

default:0

Fee amount

Example:

10.5

updateLineItems.fees.attributes

object | null

Placeholder for additional information in key:value pairs

Example:

{ "from": "sam" }

updateLineItems.shippingDetailId

string

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

Response

200

application/json

data

object[] | null

Line item details

data.id

string | null

Line item ID

Example:

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

data.itemId

any

data.position

integer

Line item position number (starts at 1)

Required range: x >= 1

Example:

1

data.name

string | null

Line item name

Example:

"Varnet Garden Light Kit"

data.sku

string

Line item SKU

Example:

"16B2GS8LD5FDS"

data.productAttributes

object[] | null

Additional line item options

Product attribute as defined within Product Catalog.

data.createdAt

string

Time line item was created

Example:

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

data.updatedAt

string

Time line item was last updated

Example:

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

data.quantity

integer

Line item quantity

Example:

15

data.priceListId

integer | null

Line item price list ID

Example:

108674

data.isActive

boolean | null

true: Item is active false: Item is inactive

Example:

true

data.price

any | null

Individual line item price

data.discounts

any[]

Individual line item discount

data.groups

string[] | null

Group or category ID to which line item belongs

data.attributes

object | null

Attributes passed by caller

Example:

{ "productFamily": "Laptop computers" }

data.channel

string

Sales channel

Example:

"12"

data.isPickup

boolean

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

Example:

true

data.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

data.shippingDetails

object

Shipping details

data.shippingDetails.id

string

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

data.shippingDetails.createdAt

string

Time shipping detail was created

Example:

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

data.shippingDetails.updatedAt

string

Time shipping detail was last updated

Example:

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

data.shippingDetails.address

object

Shipping address

data.shippingDetails.type

string

Shipping type

Example:

"SHIP_TO_ADDRESS"

data.shippingDetails.taxCode

string | null

Shipping tax code

Example:

"FR1000"

data.shippingDetails.isPickup

boolean

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

Example:

true

data.shippingDetails.altPickupPerson

object

Alternative pickup person

data.shippingDetails.pickupPerson

object

Designated pickup person

data.shippingDetails.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

data.shippingDetails.storeId

string | null

Store ID

Example:

"ABC-123"

data.shippingDetails.shippingCost

number

Shipping cost

Example:

150.25

data.shippingDetails.shippingMethodId

string

Shipping method ID

Example:

"dfsae-2d32113-32lpdd"

data.shippingDetails.shippingDiscount

number

Discount amount

Example:

150.25

data.shippingDetails.shippingMethodName

string | null

Shipping method name

Example:

"Express Delivery"

data.fulfillment

object | null

Fulfillment details

data.fulfillment.type

string | null

Fulfillment type

Example:

"WEB_SDD"

data.fulfillment.networkCode

string | null

Inventory network code

Example:

"ShipToHome"

data.fulfillment.channelId

string

Sales channel

Example:

"12"

data.fulfillment.inventoryType

string

default:availableToPurchase

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

Example:

"availableToPurchase"

data.fulfillment.inventory

object | null

The inventory response.

data.fulfillment.inventory.inventoryId

string

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

Example:

"723910d81723"

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

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

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

data.fulfillment.inventory.region

string

Region where inventory is managed

Example:

"North America"

data.fulfillment.inventory.channelId

string

Example:

"channel_xyz"

data.fulfillment.inventory.vendorId

string

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

Example:

"vendor1"

data.fulfillment.inventory.createdAt

string

Time of inventory creation

Example:

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

data.fulfillment.inventory.updatedAt

string

Time when inventory was last updated

Example:

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

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

data.fulfillment.inventory.type

string

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

Example:

"primary"

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

data.fulfillment.inventory.backorderShipmentAt

string

Time when backorder is shipped

Example:

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

data.fulfillment.inventory.preorderShipmentAt

string

Time when preorder is shipped

Example:

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

data.fulfillment.inventory.backorderLimit

integer

Maximum restock inventory quantity

Example:

50

data.fulfillment.inventory.preorderLimit

integer

Maximum first-shipping inventory quantity

Example:

40

data.fulfillment.inventory.safetyStock

integer

Reserved inventory quantity at the location

Example:

10

data.fulfillment.inventory.lowStock

integer

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

Example:

10

data.fulfillment.inventory.networkCode

string

Code of the network to which the inventory belongs

Example:

"ShipToHome"

data.fulfillment.inventory.counters

object

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

Example:

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

data.fulfillment.inventory.customAttributes

object

Placeholder for additional info

Example:

{ "isBopis": true }

data.fulfillment.inventory.networkCounters

object

Indicates inventory positions at network

Example:

{ "softReserve": 10 }

data.fulfillment.inventory.virtualCounters

object

Virtual counters are calculated at run time from counters

Example:

{ "availableToPurchase": 60 }

data.fees

object[] | null

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

data.fees.name

string | null

Attribute for which fee is applied

Example:

"gift"

data.fees.type

string | null

Fee type

Example:

"gift_wrap"

data.fees.amount

number

default:0

Fee amount

Example:

10.5

data.fees.attributes

object | null

Placeholder for additional information in key:value pairs

Example:

{ "from": "sam" }

data.adjustments

object[] | null

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

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

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

data.adjustments.reason

string

required

Price adjustment reason

Example:

"CSR Adjustment"

data.adjustments.attributes

object | null

Placeholder for additional information

Example:

{ "productFamily": "Laptop computers" }

data.adjustments.createdAt

string

Time cart was created

Example:

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

data.adjustments.updatedAt

string

Time cart was last updated

Example:

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

error

object

Errors in the updated line items

error.prices

object[]

Offers

Offer details

error.prices.price

object

required

Item or discount price details

Example:

{
  "sale": 1000.15,
  "cost": 900.15,
  "base": 2000.15,
  "unitPriceWithoutDiscounts": 2000.15,
  "lineTotalWithoutDiscounts": 2000.15,
  "lineTotalWithDiscounts": 2000.15,
  "type": "BASE"
}

error.prices.channel

string

required

Sales channel

Example:

"12"

error.prices.kind

string | null

Offer type

Example:

"PROMOTION"

error.prices.position

integer

Line item position number (starts at 1)

Required range: x >= 1

Example:

1

error.prices.discounts

object[] | null

Discounts

Promotion discount

error.prices.discounts.amount

number

Actual discount amount

Example:

1000.15

error.prices.discounts.quantity

integer

The number of items eligible for the promotional discount.

Example:

5

error.prices.discounts.proratedAmount

number

The discount amount distributed proportionally among all the selected items. The distribution is determined based on each item's price relative to the total price of all participating items. Typically, proratedAmount matches the amount. However, there might be variations, particularly in the context of Buy-Get promotions.

Example:

1000.15

error.prices.discounts.proratedQuantity

integer

This is used in conjunction with proratedAmount to determine the discount portion allocated to the respective units of BuyGet promotions. This is applicable in partial return scenarios.

Example:

5

error.prices.discounts.application

integer | null

An identifier for an instance of the Buy-Get promotion that can be applied repeatedly. For example, consider a promotion - Buy 1 shirt and get 1 pant at a 20% off. If a shopper buys three shirts, 20% discount is individually applied to each shirt-pant pair. Each such discounted pair is assigned a unique application number for tracking purposes.

Example:

1

error.prices.discounts.promotion

object

The promotion details.

Example:

{
  "id": "6197ec46e836ff000952c668",
  "value": 2000.15,
  "groupId": "61a6354d0d70e30009415f16",
  "level": 1,
  "isStackable": true,
  "isAlwaysApplied": true,
  "name": "20% OFF",
  "type": "Coupon",
  "discountType": "AMOUNT_OFF"
}

error.promotionErrors

object[]

Promotion exception details

Exception details

error.inventoryErrors

object[]

Inventory exception details

Exception details

Was this page helpful?

curl --request PATCH \
  --url https://api.fabric.inc/v3/carts/{cartId}/line-items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "updateLineItems": [
    {
      "id": "12gved0f-7645-40cb-y7b0-167f8bggdb3z",
      "sku": "13B9CL6WT2SLW",
      "quantity": 2,
      "itemId": 1730902008,
      "priceListId": 100000,
      "attributes": {
        "productFamily": "Laptop computers"
      },
      "fulfillment": {
        "type": "WEB_SDD",
        "networkCode": "ShipToHome",
        "channelId": "12",
        "inventoryType": "availableToPurchase"
      },
      "fees": [
        {
          "feeId": "73bc09d0-874a-4c3d-84d0-df1670d03578",
          "name": "gift",
          "type": "gift_wrap",
          "amount": 10.5,
          "attributes": {
            "from": "sam"
          }
        }
      ],
      "shippingDetailId": "fef78121-bee3-4448-bf1c-d5b5461dbda2"
    }
  ]
}'

{
  "data": [
    {
      "id": "12gved0f-7645-40cb-y7b0-167f8bggdb3z",
      "itemId": 1730902008,
      "position": 1,
      "name": "Varnet Garden Light Kit",
      "sku": "16B2GS8LD5FDS",
      "productAttributes": [
        {
          "attributeId": "60c2a358eb2ec30008ae70a1",
          "name": "gift wrapping (small)",
          "description": "Gift wrapping for a small package",
          "mapping": "ITEM",
          "type": "GIFT",
          "value": "true",
          "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": {
        "sale": 1000.15,
        "cost": 900.15,
        "base": 2000.15,
        "unitPriceWithoutDiscounts": 2000.15,
        "lineTotalWithoutDiscounts": 2000.15,
        "lineTotalWithDiscounts": 2000.15,
        "type": "BASE"
      },
      "discounts": [
        {
          "amount": 100.15,
          "quantity": 1,
          "proratedAmount": 100.15,
          "proratedQuantity": 1,
          "application": 1,
          "promotion": {
            "id": "6197ec46e836ff000952d668",
            "value": 2000.15,
            "groupId": "61a6354d0d70e30009415f16",
            "level": 1,
            "isStackable": true,
            "isAlwaysApplied": true,
            "name": "20% OFF",
            "type": "Coupon",
            "discountType": "AMOUNT_OFF"
          }
        }
      ],
      "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.",
          "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"
      },
      "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"
        }
      ]
    }
  ],
  "error": {
    "prices": [
      {
        "price": {
          "sale": 1000.15,
          "cost": 900.15,
          "base": 2000.15,
          "unitPriceWithoutDiscounts": 2000.15,
          "lineTotalWithoutDiscounts": 2000.15,
          "lineTotalWithDiscounts": 2000.15,
          "type": "BASE"
        },
        "kind": "PROMOTION",
        "channel": "12",
        "position": 1,
        "discounts": [
          {
            "amount": 100.15,
            "quantity": 1,
            "proratedAmount": 100.15,
            "proratedQuantity": 1,
            "application": 1,
            "promotion": {
              "id": "6197ec46e836ff000952d668",
              "value": 2000.15,
              "groupId": "61a6354d0d70e30009415f16",
              "level": 1,
              "isStackable": true,
              "isAlwaysApplied": true,
              "name": "20% OFF",
              "type": "Coupon",
              "discountType": "AMOUNT_OFF"
            }
          }
        ]
      }
    ],
    "promotionErrors": [
      {
        "itemId": 1730902008,
        "sku": "16B2GS8LD5FDS",
        "code": "UNKNOWN_ERROR",
        "detail": "Item is out of stock",
        "position": 1
      }
    ],
    "inventoryErrors": [
      {
        "itemId": 1730902008,
        "sku": "16B2GS8LD5FDS",
        "code": "UNKNOWN_ERROR",
        "detail": "Item is out of stock",
        "position": 1
      }
    ]
  }
}

Release Notes

Authorizations

Headers

Path Parameters

Body

Response