api-docs v5.116.0

API Docs

Table of contents

Inventory_Transaction

Transaction - Find

Back to top

Get array of inventory-transactions

GET /inventory-transactions

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-transactions" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
inventoryTransactions Object[]

array of inventory transactions
inventoryTransactions.id string
inventoryTransactions.createdAt number
inventoryTransactions.createdBy string
inventoryTransactions.warehouse string
inventoryTransactions.type string

adjustment,purchas,sales,transfer,receiving,packaging,return
inventoryTransactions.items Object[]
inventoryTransactions.items.sku string

item type id
inventoryTransactions.items.variantName string
inventoryTransactions.items.variantIsMedicine boolean
inventoryTransactions.items.variantIsMedicineDangerous boolean
inventoryTransactions.items.quantity number

direct quantity change (adjustment)
inventoryTransactions.items.note string
inventoryTransactions.items.metadata Object
inventoryTransactions.items.adjustment number

[for: adjustment] quantity update, + for replenishment, - for takes
inventoryTransactions.items.control string

[for: adjustment; tracked items] control number, batch id or external identifier
inventoryTransactions.items.expiresAt number

[for: adjustment; tracked items]
inventoryTransactions.items.price number

[for: purchase, sales orders] price override
inventoryTransactions.items.tax number

[for: purchase, sales orders] tax override
inventoryTransactions.items.taxCode string

[for: purchase, sales orders] inclusive, exclusive
inventoryTransactions.items.taxComplication string

[for: purchase, sales orders] inclusive, exclusive
inventoryTransactions.metadata Object
inventoryTransactions.reason string
inventoryTransactions.invoice string
inventoryTransactions.expiresAt number
inventoryTransactions.transaction string

[types: adjustment, receiving, packaging, return] transaction id this receiving, packaging, or return is for
inventoryTransactions.supplier string

[types: purchase] supplier id
inventoryTransactions.supplierType string

[types: purchase] organization,inventory-supplier
inventoryTransactions.acknowledgedAt number

[types: purchase]
inventoryTransactions.acknowledgedBy string

[types: purchase]
inventoryTransactions.rejectedAt number

[types: purchase]
inventoryTransactions.rejectedBy string

[types: purchase]
inventoryTransactions.customer string

[types: sales] account id
inventoryTransactions.customerType string

[types: sales] patient,org-member,personal-details
inventoryTransactions.customerHasPWDId boolean
inventoryTransactions.customerHasOSCASeniorCitizenId boolean
inventoryTransactions.fulfilledItems Object[]

[types: sales]
inventoryTransactions.fulfilledAt number

[types: sales]
inventoryTransactions.fulfilledBy string

[types: sales]
inventoryTransactions.source string

[types: transfer] warehouse id
inventoryTransactions.destination string

[types: transfer] warehouse id
inventoryTransactions.billTo string

[types: purchase, sales] account id
inventoryTransactions.shippedAt number
inventoryTransactions.shippedBy string
inventoryTransactions.shipTo string

[types: purchase, sales, transfer] simple location or address
inventoryTransactions.receivedAt number

[types: packaging, order]
inventoryTransactions.receivedBy string

[types: packaging, order]
inventoryTransactions.approvedItems Object[]

[types: purhase]
inventoryTransactions.approvedAt number

[types: purhase return]
inventoryTransactions.approvedBy string

[types: purhase return]

Success response example

Success response example - Success-Response:

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

Transaction - Get

Back to top

Get an inventory-transaction's details

GET /inventory-transactions/: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-transaction

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
warehouse string
type string

adjustment,purchas,sales,transfer,receiving,packaging,return
items Object[]
items.sku string

item type id
items.variantName string
items.variantIsMedicine boolean
items.variantIsMedicineDangerous boolean
items.quantity number

direct quantity change (adjustment)
items.note string
items.metadata Object
items.adjustment number

[for: adjustment] quantity update, + for replenishment, - for takes
items.control string

[for: adjustment; tracked items] control number, batch id or external identifier
items.expiresAt number

[for: adjustment; tracked items]
items.price number

[for: purchase, sales orders] price override
items.tax number

[for: purchase, sales orders] tax override
items.taxCode string

[for: purchase, sales orders] inclusive, exclusive
items.taxComplication string

[for: purchase, sales orders] inclusive, exclusive
metadata Object
reason string
invoice string
expiresAt number
transaction string

[types: adjustment, receiving, packaging, return] transaction id this receiving, packaging, or return is for
supplier string

[types: purchase] supplier id
supplierType string

[types: purchase] organization,inventory-supplier
acknowledgedAt number

[types: purchase]
acknowledgedBy string

[types: purchase]
rejectedAt number

[types: purchase]
rejectedBy string

[types: purchase]
customer string

[types: sales] account id
customerType string

[types: sales] patient,org-member,personal-details
customerHasPWDId boolean
customerHasOSCASeniorCitizenId boolean
fulfilledItems Object[]

[types: sales]
fulfilledAt number

[types: sales]
fulfilledBy string

[types: sales]
source string

[types: transfer] warehouse id
destination string

[types: transfer] warehouse id
billTo string

[types: purchase, sales] account id
shippedAt number
shippedBy string
shipTo string

[types: purchase, sales, transfer] simple location or address
receivedAt number

[types: packaging, order]
receivedBy string

[types: packaging, order]
approvedItems Object[]

[types: purhase]
approvedAt number

[types: purhase return]
approvedBy string

[types: purhase return]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "type": "adjustment"
}

Transaction - Patch

Back to top

Update an inventory-transaction

PATCH /inventory-transactions/: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-transaction
createdAt number optional Default value: currentTime
warehouse string
type string Allowed values: adjustment,purchas,s,ales,transfer,receiving,packaging,return
items Object[]
items.sku string

item type id
items.variantName string
items.variantIsMedicine boolean
items.variantIsMedicineDangerous boolean
items.quantity number

direct quantity change (adjustment)
items.note string
items.metadata Object
items.adjustment number

[for: adjustment] quantity update, + for replenishment, - for takes
items.control string

[for: adjustment; tracked items] control number, batch id or external identifier
items.expiresAt number

[for: adjustment; tracked items]
items.price number

[for: purchase, sales orders] price override
items.tax number

[for: purchase, sales orders] tax override
items.taxCode string

[for: purchase, sales orders] inclusive, exclusive
items.taxComplication string

[for: purchase, sales orders]

Allowed values: inclusive,exclusive
metadata Object optional
reason string optional
invoice string optional
expiresAt number optional
transaction string optional

[types: adjustment, receiving, packaging, return] transaction id this receiving, packaging, or return is for
supplier string optional

[types: purchase] supplier id
supplierType string optional

[types: purchase]

Allowed values: organization,inventory-supplier
acknowledgedAt number optional

[types: purchase]
acknowledgedBy string optional

[types: purchase]
rejectedAt number optional

[types: purchase]
rejectedBy string optional

[types: purchase]
customer string optional

[types: sales] account id
customerType string optional

[types: sales]

Allowed values: patient,org-member,personal-details
customerHasPWDId boolean optional
customerHasOSCASeniorCitizenId boolean optional
fulfilledItems Object[] optional

[types: sales]
fulfilledAt number optional

[types: sales]
fulfilledBy string optional

[types: sales]
source string optional

[types: transfer] warehouse id
destination string optional

[types: transfer] warehouse id
billTo string optional

[types: purchase, sales] account id
shippedAt number optional
shippedBy string optional
shipTo string optional

[types: purchase, sales, transfer] simple location or address
receivedAt number optional

[types: packaging, order]
receivedBy string optional

[types: packaging, order]
approvedItems Object[] optional

[types: purhase]
approvedAt number optional

[types: purhase return]
approvedBy string optional

[types: purhase return]

Examples

Example usage:

curl "https://yourdomain.com/inventory-transactions/<inventory-transaction-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
     "reason": "updated reason"
  }'

Parameters examples

json - Request-Example

{
  "reason": "updated reason"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
warehouse string
type string

adjustment,purchas,sales,transfer,receiving,packaging,return
items Object[]
items.sku string

item type id
items.variantName string
items.variantIsMedicine boolean
items.variantIsMedicineDangerous boolean
items.quantity number

direct quantity change (adjustment)
items.note string
items.metadata Object
items.adjustment number

[for: adjustment] quantity update, + for replenishment, - for takes
items.control string

[for: adjustment; tracked items] control number, batch id or external identifier
items.expiresAt number

[for: adjustment; tracked items]
items.price number

[for: purchase, sales orders] price override
items.tax number

[for: purchase, sales orders] tax override
items.taxCode string

[for: purchase, sales orders] inclusive, exclusive
items.taxComplication string

[for: purchase, sales orders] inclusive, exclusive
metadata Object
reason string
invoice string
expiresAt number
transaction string

[types: adjustment, receiving, packaging, return] transaction id this receiving, packaging, or return is for
supplier string

[types: purchase] supplier id
supplierType string

[types: purchase] organization,inventory-supplier
acknowledgedAt number

[types: purchase]
acknowledgedBy string

[types: purchase]
rejectedAt number

[types: purchase]
rejectedBy string

[types: purchase]
customer string

[types: sales] account id
customerType string

[types: sales] patient,org-member,personal-details
customerHasPWDId boolean
customerHasOSCASeniorCitizenId boolean
fulfilledItems Object[]

[types: sales]
fulfilledAt number

[types: sales]
fulfilledBy string

[types: sales]
source string

[types: transfer] warehouse id
destination string

[types: transfer] warehouse id
billTo string

[types: purchase, sales] account id
shippedAt number
shippedBy string
shipTo string

[types: purchase, sales, transfer] simple location or address
receivedAt number

[types: packaging, order]
receivedBy string

[types: packaging, order]
approvedItems Object[]

[types: purhase]
approvedAt number

[types: purhase return]
approvedBy string

[types: purhase return]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "type": "adjustment"
}

Transaction - Post

Back to top

Create an inventory-transaction

POST /inventory-transactions

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
createdAt number optional Default value: currentTime
warehouse string
type string Allowed values: adjustment,purchas,s,ales,transfer,receiving,packaging,return
items Object[]
items.sku string

item type id
items.variantName string
items.variantIsMedicine boolean
items.variantIsMedicineDangerous boolean
items.quantity number

direct quantity change (adjustment)
items.note string
items.metadata Object
items.adjustment number

[for: adjustment] quantity update, + for replenishment, - for takes
items.control string

[for: adjustment; tracked items] control number, batch id or external identifier
items.expiresAt number

[for: adjustment; tracked items]
items.price number

[for: purchase, sales orders] price override
items.tax number

[for: purchase, sales orders] tax override
items.taxCode string

[for: purchase, sales orders] inclusive, exclusive
items.taxComplication string

[for: purchase, sales orders]

Allowed values: inclusive,exclusive
metadata Object optional
reason string optional
invoice string optional
expiresAt number optional
transaction string optional

[types: adjustment, receiving, packaging, return] transaction id this receiving, packaging, or return is for
supplier string optional

[types: purchase] supplier id
supplierType string optional

[types: purchase]

Allowed values: organization,inventory-supplier
acknowledgedAt number optional

[types: purchase]
acknowledgedBy string optional

[types: purchase]
rejectedAt number optional

[types: purchase]
rejectedBy string optional

[types: purchase]
customer string optional

[types: sales] account id
customerType string optional

[types: sales]

Allowed values: patient,org-member,personal-details
customerHasPWDId boolean optional
customerHasOSCASeniorCitizenId boolean optional
fulfilledItems Object[] optional

[types: sales]
fulfilledAt number optional

[types: sales]
fulfilledBy string optional

[types: sales]
source string optional

[types: transfer] warehouse id
destination string optional

[types: transfer] warehouse id
billTo string optional

[types: purchase, sales] account id
shippedAt number optional
shippedBy string optional
shipTo string optional

[types: purchase, sales, transfer] simple location or address
receivedAt number optional

[types: packaging, order]
receivedBy string optional

[types: packaging, order]
approvedItems Object[] optional

[types: purhase]
approvedAt number optional

[types: purhase return]
approvedBy string optional

[types: purhase return]

Examples

Example usage:

curl "https://yourdomain.com/inventory-transactions" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
      "warehouse": "facility-id",
      "items": [
        {
          "variantName": "some variant name"
        }
      ]
  }'

Parameters examples

json - Request-Example

{
  "warehouse": "facility-id",
  "items": [
    {
      "variantName": "some variant name"
    }
  ]
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
warehouse string
type string

adjustment,purchas,sales,transfer,receiving,packaging,return
items Object[]
items.sku string

item type id
items.variantName string
items.variantIsMedicine boolean
items.variantIsMedicineDangerous boolean
items.quantity number

direct quantity change (adjustment)
items.note string
items.metadata Object
items.adjustment number

[for: adjustment] quantity update, + for replenishment, - for takes
items.control string

[for: adjustment; tracked items] control number, batch id or external identifier
items.expiresAt number

[for: adjustment; tracked items]
items.price number

[for: purchase, sales orders] price override
items.tax number

[for: purchase, sales orders] tax override
items.taxCode string

[for: purchase, sales orders] inclusive, exclusive
items.taxComplication string

[for: purchase, sales orders] inclusive, exclusive
metadata Object
reason string
invoice string
expiresAt number
transaction string

[types: adjustment, receiving, packaging, return] transaction id this receiving, packaging, or return is for
supplier string

[types: purchase] supplier id
supplierType string

[types: purchase] organization,inventory-supplier
acknowledgedAt number

[types: purchase]
acknowledgedBy string

[types: purchase]
rejectedAt number

[types: purchase]
rejectedBy string

[types: purchase]
customer string

[types: sales] account id
customerType string

[types: sales] patient,org-member,personal-details
customerHasPWDId boolean
customerHasOSCASeniorCitizenId boolean
fulfilledItems Object[]

[types: sales]
fulfilledAt number

[types: sales]
fulfilledBy string

[types: sales]
source string

[types: transfer] warehouse id
destination string

[types: transfer] warehouse id
billTo string

[types: purchase, sales] account id
shippedAt number
shippedBy string
shipTo string

[types: purchase, sales, transfer] simple location or address
receivedAt number

[types: packaging, order]
receivedBy string

[types: packaging, order]
approvedItems Object[]

[types: purhase]
approvedAt number

[types: purhase return]
approvedBy string

[types: purhase return]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "type": "adjustment"
}

results matching ""

    No results matching ""