api-docs v5.116.0

API Docs

Table of contents

Inventory_Tracker

Tracker - Delete

Back to top

Delete an inventory-tracker's details

DELETE /inventory-trackers/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of inventory-tracker

Examples

Example usage:

curl "https://yourdomain.com/inventory-trackers/<inventory-tracker-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
externalId String

control number, batch id or external identifier
createdAt Date
createdBy String
organization String

parent organization
warehouse String

relevant warehouse (branch if branch specific)
sku String

variant sku
quantity Number
parent String

parent tracked item, for linking 'consumed' trackers with original
status String

track status
expiresAt Date

track expiration

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "quantity": 1
}

Tracker - Find

Back to top

Get array of inventory-trackers

GET /inventory-trackers

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/inventory-trackers" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
inventoryTrackers Object[]

array of inventory tracker
inventoryTrackers.id String
inventoryTrackers.externalId String

control number, batch id or external identifier
inventoryTrackers.createdAt Date
inventoryTrackers.createdBy String
inventoryTrackers.organization String

parent organization
inventoryTrackers.warehouse String

relevant warehouse (branch if branch specific)
inventoryTrackers.sku String

variant sku
inventoryTrackers.quantity Number
inventoryTrackers.parent String

parent tracked item, for linking 'consumed' trackers with original
inventoryTrackers.status String

track status
inventoryTrackers.expiresAt Date

track expiration

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "service-id",
    "warehouse": "facility-id",
    "quantity": 1
  },
  {
    "id": "service-id",
    "warehouse": "facility-id",
    "quantity": 1
  }
]

Tracker - Get

Back to top

Get an inventory-tracker's details

GET /inventory-trackers/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of inventory-tracker

Examples

Example usage:

curl "https://yourdomain.com/inventory-trackers/<inventory-tracker-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
externalId String

control number, batch id or external identifier
createdAt Date
createdBy String
organization String

parent organization
warehouse String

relevant warehouse (branch if branch specific)
sku String

variant sku
quantity Number
parent String

parent tracked item, for linking 'consumed' trackers with original
status String

track status
expiresAt Date

track expiration

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "quantity": 1
}

Tracker - Patch

Back to top

Update an inventory-tracker

PATCH /inventory-trackers/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of inventory-tracker
externalId String optional
createdAt Date optional Default value: currentTime
createdBy String optional
organization String optional

parent organization
warehouse String

relevant warehouse (branch if branch specific)
quantity Number optional Default value: 1
status String optional

track status
expiresAt Date optional

track expiration

Examples

Example usage:

curl "https://yourdomain.com/inventory-trackers/<inventory-tracker-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
     "name": "Updated Name"
  }'

Parameters examples

json - Request-Example

{
  "name": "Updated Name"
}

Success response

Success response - Success 200

Name Type Description
id String
externalId String

control number, batch id or external identifier
createdAt Date
createdBy String
organization String

parent organization
warehouse String

relevant warehouse (branch if branch specific)
sku String

variant sku
quantity Number
parent String

parent tracked item, for linking 'consumed' trackers with original
status String

track status
expiresAt Date

track expiration

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "quantity": 1
}

Tracker - Post

Back to top

Create an inventory-tracker

POST /inventory-trackers

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id String optional

auto-generated if not provided
externalId String optional
createdAt Date optional Default value: currentTime
createdBy String optional
organization String optional

parent organization
warehouse String

relevant warehouse (branch if branch specific)
sku String

variant sku
quantity Number optional Default value: 1
parent String optional

parent tracked item, for linking 'consumed' trackers with original
status String optional

track status
expiresAt Date optional

track expiration

Examples

Example usage:

curl "https://yourdomain.com/inventory-trackers" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
      "warehouse": "facility-id",
      "name": "Product 1"
  }'

Parameters examples

json - Request-Example

{
  "warehouse": "facility-id",
  "name": "Product 1"
}

Success response

Success response - Success 200

Name Type Description
id String
externalId String

control number, batch id or external identifier
createdAt Date
createdBy String
organization String

parent organization
warehouse String

relevant warehouse (branch if branch specific)
sku String

variant sku
quantity Number
parent String

parent tracked item, for linking 'consumed' trackers with original
status String

track status
expiresAt Date

track expiration

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "quantity": 1
}

results matching ""

    No results matching ""