API Guides
Explore our API endpoints, request parameters, and response formats.
Find Item By Item ID
Find Item By Item ID
Request Type: GET API Endpoint: <url>/api/inventory/item/:item_id Mandatory Headers Properties: Authorization (type: string): the valid access token from the authentication. Mandatory...
Delete Item By Item ID
Delete Item By Item ID
Request Type: DELETE API Endpoint: <url>/api/inventory/item/:item_id Mandatory Headers Properties: Authorization (type: string): the valid access token from the authentication. Mandatory...
Update Item By Item ID
Update Item By Item ID
Request Type: PATCH API Endpoint: <url>/api/inventory/item/:item_id Mandatory Headers Properties: Authorization (type: string): the valid access token from the authentication. Mandatory...
Create Inventory Item
Create Inventory Item
Request Type: POST API Endpoint: <url>/api/inventory Mandatory Headers Properties: Authorization (type: string): the valid access token from the authentication. Sample...
Find Inventory Item by Query
Find Inventory Item by Query
Request Type: GET API Endpoint: <url>/api/inventory Mandatory Headers Properties: Authorization (type: string): the valid access token from the authentication. Query...
Assign Item to Inventory (from an Order)
Assign Item to Inventory (from an Order)
Request Type: POST API Endpoint: <url>/api/orders/:order_id/line_items/:line_item_id/assign_to_inventory Mandatory Headers Properties: Authorization (type: string): the valid access token from the authentication. Mandatory...
Fulfill from Inventory (into an Order)
Fulfill from Inventory (into an Order)
Request Type: POST API Endpoint: <url>/api/orders/:order_id/assign_inventory_to_order Mandatory Headers Properties: Authorization (type: string): the valid access token from the authentication. Mandatory...