Skip to main content

Inventory Management

This page provides comprehensive information and documentation on a set of API methods specifically designed to handle inventory management items.

Price Lists

Price lists are used to manage prices of products with different currencies.

Price lists are created and managed by the marketplace owner in Omnitron. The marketplace owner can create, update, and delete price lists as needed.

Schema

{
"id": "uuid",
"name": "string",
"code": "string",
"currency": "enum(TRY, USD, EUR, EGP, GBP, MAD, PLN, SAR, RON, UAH, CZK, HUF, RUB, BGN, IQD, KWD, BHD, OMR, QAR, AED, NGN)",
"created_at": "datetime",
"updated_at": "datetime"
}

Retrieve PLI01

curl -X GET "https://example.com/api/i1/price-lists/" \
-H "Content-Type: application/json" \
-H "Authentication: Bearer {TOKEN}"

Example Response

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "4f61bf48-7f9f-49a5-b5be-ea55b020e058",
"name": "Sample Price List",
"code": "SPL",
"currency": "USD",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z"
}
]
}

Available Query Parameters

KeyType
namestring
name__containsstring
name__icontainsstring (case-insensitive)
codestring
currencystring
created_at__gtedatetime
created_at__gtdatetime
created_at__ltedatetime
created_at__ltdatetime
updated_at__gtedatetime
updated_at__gtdatetime
updated_at__ltedatetime
updated_at__ltdatetime

Possible HTTP Status Codes

  • 200 OK: Price Lists retrieved successfully.
  • 401 Unauthorized: Invalid authentication header (missing, invalid value, etc.).
  • 415 Unsupported Media Type: Invalid content-type header (missing, invalid format, etc.).
  • 500 Internal Server Error: Unexpected server error.

Stock Lists

Stock lists are used to manage stocks of products with different locations.

Stock lists are created and managed by the marketplace owner in Omnitron. The marketplace owner can create, update, and delete stock lists as needed.

Schema

{
"id": "uuid",
"name": "string",
"code": "string",
"created_at": "datetime",
"updated_at": "datetime"
}

Retrieve SLI01

curl -X GET "https://example.com/api/i1/stock-lists/" \
-H "Content-Type: application/json" \
-H "Authentication: Bearer {TOKEN}"

Example Response

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "3ae40ae9-2f60-45cf-8282-91b0a8abc5a8",
"name": "Sample Stock List",
"code": "SSL",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z"
}
]
}

Available Query Parameters

KeyType
namestring
name__containsstring
name__icontainsstring (case-insensitive)
codestring
created_at__gtedatetime
created_at__gtdatetime
created_at__ltedatetime
created_at__ltdatetime
updated_at__gtedatetime
updated_at__gtdatetime
updated_at__ltedatetime
updated_at__ltdatetime

Possible HTTP Status Codes

  • 200 OK: Stock Lists retrieved successfully.
  • 401 Unauthorized: Invalid authentication header (missing, invalid value, etc.).
  • 415 Unsupported Media Type: Invalid content-type header (missing, invalid format, etc.).
  • 500 Internal Server Error: Unexpected server error.