Soft reservation

Getting Started

Authentication v3

Concepts
System Apps
User Apps
Authentication Endpoints

Product Catalog

Product Catalog API - Overview
Developer Guide
Data Ingestion Best Practices
Attributes & Attribute Mapping
Categories
Products
Collections
Background Jobs
Bulk Import & Export
Published Products

Orders

Orders (3.0.0)
Developer Guide
Orders FAQ
Shopping Lists
Shipping Methods
Imports
Exports
Orders
Frauds
Notifications
Backorders Preorders
Cancellations
Allocations
Shipments
Inventory Transfers
Tracking
Invoices
Payments
Credits
Appeasements
Returns

Inventory

Integrations

Offers

Offers (3.0.0)
Developer Guide
Real-time Pricing Engine
Price Lists
Prices
Price Types
Price Controls
Price Methods
Priced Products
Add-ons
Promotions
Coupons
Coupon Codes
Redemptions
Product Exclusion Lists
Segments
Imports
Exports
Attributes
Webhook Events

Carts

Overview
Developer Guides
Carts
Order Draft
Items
Addresses
Payments
Fulfillment
Customer
Coupons
Validations
Cart Orchestrator

Customers

Customer Profile
Customer Address
Customer Self

POST

inventory-networks

actions

soft-reserve

Authorizations

Authorization

string

headerrequired

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

cartId

string

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

createdAt

string

Date when soft reservation was created

expiresAt

string

Date when soft reservation will expire

string

networkCode

string

Network for which items needs to be reserved. Optional parameter

orderId

string

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

orderNumber

string

deprecated

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

orderType

string

Order type, default value is STANDARD. Optional parameter

updatedAt

string

Date when soft reservation was updated

vendorId

string

VendorId for which soft reserve requested. Optional parameter

Response

201 - application/json

AggregatedNetworksResponse model

aggregatedNetworks

object[]

Aggregated networks

aggregatedNetworks.backorderLimit

integer

The maximum restock inventory quantity.

aggregatedNetworks.backorderShipmentAt

string

The timestamp for when a backorder is shipped.

aggregatedNetworks.channelId

string

The sales channel ID; identifies business operations location.

aggregatedNetworks.counters

object

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

aggregatedNetworks.createdAt

string

Time of inventory creation

aggregatedNetworks.customAttributes

object

Placeholder for additional info

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.

aggregatedNetworks.inventoryId

string

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

aggregatedNetworks.isNoStock

boolean

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

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.

aggregatedNetworks.leadTime

string

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

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.

aggregatedNetworks.lowStock

integer

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

aggregatedNetworks.networkCode

string

Code of the network to which the inventory belongs

aggregatedNetworks.networkCounters

object

Indicates inventory positions at network

aggregatedNetworks.preorderLimit

integer

The maximum preorder limit.

aggregatedNetworks.preorderShipmentAt

string

Time when preorder is shipped

aggregatedNetworks.region

string

Region where inventory is managed

aggregatedNetworks.safetyStock

integer

Reserved inventory quantity at the location

aggregatedNetworks.segment

string

Segment of the inventory

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.

aggregatedNetworks.status

enum<string>

Inventory status IN_STOCK, LOW_STOCK, etc.

Available options:

IN_STOCK,

LOW_STOCK,

OUT_OF_STOCK,

BACKORDER_STOCK,

PREORDER_STOCK

aggregatedNetworks.type

string

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

aggregatedNetworks.updatedAt

string

Time when inventory was last updated

aggregatedNetworks.vendorId

string

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

aggregatedNetworks.virtualCounters

object

Virtual counters are calculated at run time from counters

aggregatedNetworks.virtualCountersStatus

object

Virtual counters are calculated at run time from counters

Was this page helpful?

Release soft reservation Overview