Release soft reservation

Release soft reservation.

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

required

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

Body

application/json

SoftReserveRequest model

items

object[]

required

Items which needs to be reserved. Required parameter

Show child attributes

items.channelId

string

required

ChannelId for the item which needs to be reserved. Required parameter

Example:

"3"

items.lineItemId

string

required

lineItemId of product. Required parameter

Example:

"2"

items.quantity

integer

required

quantity that needs to be reserved. Required parameter

Example:

5

items.sku

string

required

sku of product. Required parameter

Example:

"OMSTESTSKU1"

items.backorderQuantity

integer

Back order quantity that needs to be reserved

Example:

5

items.errorMessage

string

items.itemId

string

itemId of product. Optional parameter

Example:

"451008962041"

items.locationNumber

integer

LocationNumber for which this item needs to be reserved. Optional parameter

Example:

999

items.networkCode

string

Network for which this item needs to be reserved. Optional parameter

Example:

"ShipToHome"

items.preorderQuantity

integer

Pre order quantity that needs to be reserved

Example:

5

items.reservedNetworkCodes

string[]

items.status

string

items.type

string

Order type, default value is STANDARD. Optional parameter

Example:

"['STANDARD','PREORDER','BACKORDER']"

cartId

string

CartId for which soft reserve requested, at least one of orderNumber or cartId or OrderId is required

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

createdAt

string

Date when soft reservation was created

Example:

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

expiresAt

string

Date when soft reservation will expire

Example:

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

id

string

ID

Example:

"\"Infinity\""

networkCode

string

Network for which items needs to be reserved. Optional parameter

Example:

"DCOnly"

orderId

string

Order ID for which soft reserve requested, at least one of orderNumber or cartId or OrderId is required

Example:

"62ab7af89ed14510827fe074"

orderNumber

string

deprecated

OrderNumber for which soft reserve requested, at least one of orderNumber or cartId or OrderId is required

Example:

"order_20220729_883"

orderType

string

Order type, default value is STANDARD. Optional parameter

Example:

"['STANDARD','CSR']"

updatedAt

string

Date when soft reservation was updated

Example:

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

vendorId

string

VendorId for which soft reserve requested. Optional parameter

Example:

"test_vendor"

Response

200

application/json

OK

AggregatedNetworksResponse model

aggregatedNetworks

object[]

Aggregated networks

Displays an aggregate representation of the SKU that includes all locations for which the sku is available in that network.

Show child attributes

aggregatedNetworks.backorderLimit

integer

The maximum restock inventory quantity.

Example:

50

aggregatedNetworks.backorderShipmentAt

string

The timestamp for when a backorder is shipped.

Example:

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

aggregatedNetworks.channelId

string

The sales channel ID; identifies business operations location.

Example:

"channel_xyz"

aggregatedNetworks.counters

object

Your defined inventory positions. These can be included in availability calculations.

Show child attributes

aggregatedNetworks.counters.{key}

integer

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

Example:

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

aggregatedNetworks.createdAt

string

Time of inventory creation

Example:

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

aggregatedNetworks.customAttributes

object

Placeholder for additional info

Show child attributes

aggregatedNetworks.customAttributes.{key}

string

Placeholder for additional info

Example:

"{\"isBopis\":true}"

Example:

{ "isBopis": true }

aggregatedNetworks.hasInfiniteInventory

boolean

default:

false

The infinite inventory flag. Setting this to true means inventory can be used any number of times and does not have a consumption limit. Setting this to false means inventory can't be used infinitely, and has a consumption limit.

Example:

false

aggregatedNetworks.inventoryId

string

The fabric system-generated inventory ID. This ID is generated during inventory creation.

Example:

"723910d81723"

aggregatedNetworks.isNoStock

boolean

An attribute used to indicate that a SKU is out of stock.

Example:

false

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

aggregatedNetworks.leadTime

string

The time between when an order is placed to replenish inventory and when the order is received at warehouse.

Example:

"5 days"

aggregatedNetworks.locationNumber

integer

Represents the warehouse or store location where the inventory is stored. The locationNumber is crucial for inventory management. When creating or updating inventory, you need to include the locationNumber to specify which location the inventory belongs to.

Example:

12345

aggregatedNetworks.lowStock

integer

The lowStock parameter is used to alert low stock at a location when inventory is below a set number.

Example:

10

aggregatedNetworks.networkCode

string

Code of the network to which the inventory belongs

Example:

"ShipToHome"

aggregatedNetworks.networkCounters

object

Indicates inventory positions at network

Show child attributes

aggregatedNetworks.networkCounters.{key}

integer

Indicates inventory positions at network

Example:

{ "softReserve": 10 }

aggregatedNetworks.preorderLimit

integer

The maximum preorder limit.

Example:

40

aggregatedNetworks.preorderShipmentAt

string

Time when preorder is shipped

Example:

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

aggregatedNetworks.region

string

Region where inventory is managed

Example:

"North America"

aggregatedNetworks.safetyStock

integer

Reserved inventory quantity at the location

Example:

10

aggregatedNetworks.segment

string

Segment of the inventory

Example:

"Sample Segment"

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

aggregatedNetworks.status

enum<string>

Inventory status IN_STOCK, LOW_STOCK, etc.

Available options:

IN_STOCK,

LOW_STOCK,

OUT_OF_STOCK,

BACKORDER_STOCK,

PREORDER_STOCK

Example:

" IN_STOCK"

aggregatedNetworks.type

string

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

Example:

"primary"

aggregatedNetworks.updatedAt

string

Time when inventory was last updated

Example:

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

aggregatedNetworks.vendorId

string

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

Example:

"vendor1"

aggregatedNetworks.virtualCounters

object

Virtual counters are calculated at run time from counters

Show child attributes

aggregatedNetworks.virtualCounters.availableBackorder

string

aggregatedNetworks.virtualCounters.availablePreorder

string

aggregatedNetworks.virtualCounters.availableToPurchase

string

aggregatedNetworks.virtualCountersStatus

object

Virtual counters are calculated at run time from counters

Show child attributes

aggregatedNetworks.virtualCountersStatus.availableBackorder

string

aggregatedNetworks.virtualCountersStatus.availablePreorder

string

aggregatedNetworks.virtualCountersStatus.availableToPurchase

string