Inventory

Assign product to vendor and vendor location. Manage inventory level on vendor location

Assign product to specific Vendor

Assign the product to a specific Vendor on the marketplace

Request
path Parameters
product_id
required
string
Request Body schema: application/json
optional
vendor_ids
Array of integers (vendor-id)
Responses
200

200 Success.

post/rest/V1/vendor_product/update/{product_id}
Request samples
application/json
{
  • "vendor_ids": [
    ]
}
Response samples
application/json
{
  • "success": true,
  • "message": "Assigned product 9527 to vendors"
}

Get inventory for a specific product

Get inventory for a specific product

Request
path Parameters
product_id
required
string
Responses
200

200 Success.

get/rest/V1/location_product/{product_id}
Response samples
application/json
{
  • "inventory": [
    ],
  • "total": 9999,
  • "count": 2
}

Update the product inventory

Update the product inventory to specific Vendor's Location / Warehuse on the marketplace

Request
path Parameters
product_id
required
string
Request Body schema: application/json
optional
Array of objects (product-inventory-assignment)
Responses
200

200 Success.

post/rest/V1/location_product/{product_id}
Request samples
application/json
{
  • "inventories": [
    ]
}
Response samples
application/json
{
  • "success": true,
  • "message": "product 9527 inventory updated"
}

Get inventory for a specific vendor

Get inventory for a specific vendor

Example - Get inventory for sku value equals to 'example-sku'
curl --location --globoff 'https://your-marketplace-host/rest/V1/inventory/source-items?searchCriteria[filterGroups][0][filters][0][conditionType]=eq&searchCriteria[currentPage]=1&searchCriteria[pageSize]=10&searchCriteria[filterGroups][0][filters][0][field]=sku&searchCriteria[filterGroups][0][filters][0][value]={example-sku}'
Request
query Parameters
searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[sortOrders][0][field]
string

Sorting field.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[pageSize]
integer

Page size.

searchCriteria[currentPage]
integer

Current page.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/inventory/source-items
Response samples
application/json
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}