Inventory
The Inventory Platform APIs allow you to manage inventory updates, export jobs, and related inventory management functionalities.
Simplify your product management. Create, retrieve, update, and delete products globally. Handle variants and attributes at the global level. Manage inventory and perform bulk operations at the company level. Additionally, oversee HSN codes at the company level and manage product assets globally for comprehensive product management.
Operations
POST
# Update inventories.
FDK Method Name: updateInventories
Allows to add Inventory for particular size and store.
Parameters
company_id
integer
Required
Id of the company associated to product that is to be viewed.
Request body
meta
object
Additional metadata for the inventory request.
Default Value : [object Object]
payload
array of object (InventoryPayload)
The list of inventory payloads.
Maximum Items : 50
Array of InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
Required
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
Required
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
sellable_quantity
integer
The sellable quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
trace_id
string
The trace ID of the inventory payload.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Returns a success or partial success response
InventoryUpdateResponseSchema
items
array of object (InventoryResponseItem)
Array of InventoryResponseItem
data
object (InventoryPayload)
InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
sellable_quantity
integer
The sellable quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
trace_id
string
The trace ID of the inventory payload.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
reason
object (InventoryFailedReason)
InventoryFailedReason
errors
string
It is the error message of the inventory error response.
message
string
It is the message of the activity performed.
reason_code
integer
It is the reason code of the inventory error response.
message
string
It is the success message of the inventory update.
success
boolean
It is the success status of the inventory update.
Examples
Parameters
company_id:
10
body:
body
Was this section helpful?
POST
Response