PurchaseOrders

Returns purchase orders list

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

Pageinteger · int32Optional

PageSizeinteger · int32Optional

clientIdstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

commentsstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

appointmentNumberstring · nullableOptional

appointmentDatestring · date-time · nullableOptional

requiredDatestring · date-time · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

purchaseOrderNumberstring · nullableOptional

get

/purchase-orders

HTTPcURLJavaScriptPython

GET /purchase-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "comments": "text",
    "referenceNumber": "text",
    "reference1": "text",
    "reference2": "text",
    "reference3": "text",
    "appointmentNumber": "text",
    "appointmentDate": "2026-03-02T18:47:36.301Z",
    "requiredDate": "2026-03-02T18:47:36.301Z",
    "dateCreated": "2026-03-02T18:47:36.301Z",
    "closeDate": "2026-03-02T18:47:36.301Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderNumber": "text",
    "vendor": {
      "companyName": "text",
      "email": "text",
      "phone": "text",
      "contactPerson": "text",
      "description": "text",
      "address": {
        "address1": "text",
        "address2": "text",
        "city": "text",
        "stateProvince": "text",
        "zipPostalCode": "text",
        "country": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "client": {
        "description": "text",
        "ssccCompanyId": "text",
        "companyName": "text",
        "email": "text",
        "phone": "text",
        "contactPerson": "text",
        "taxId": "text",
        "address1": "text",
        "address2": "text",
        "city": "text",
        "stateProvince": "text",
        "zipPostalCode": "text",
        "country": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "vendorCode": "text"
    },
    "warehouse": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "warehouseCode": "text",
      "name": "text",
      "description": "text",
      "phone": "text",
      "email": "text",
      "referenceNumber": "text",
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "text"
    }
  }
]

Create new purchase order

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

commentsstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

appointmentNumberstring · nullableOptional

appointmentDatestring · date-time · nullableOptional

requiredDatestring · date-time · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

vendorIdstring · uuidOptional

warehouseIdstring · uuidOptional

purchaseOrderNumberstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/purchase-orders

HTTPcURLJavaScriptPython

POST /purchase-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 644

{
  "comments": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "appointmentNumber": "text",
  "appointmentDate": "2026-03-02T18:47:36.301Z",
  "requiredDate": "2026-03-02T18:47:36.301Z",
  "dateCreated": "2026-03-02T18:47:36.301Z",
  "closeDate": "2026-03-02T18:47:36.301Z",
  "vendorId": "123e4567-e89b-12d3-a456-426614174000",
  "warehouseId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseOrderNumber": "text",
  "lines": [
    {
      "lineNumber": 1,
      "packsize": 1,
      "numberOfPacks": 1,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "orderedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Update an existing purchase order

put

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

commentsstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

appointmentNumberstring · nullableOptional

appointmentDatestring · date-time · nullableOptional

requiredDatestring · date-time · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

put

/purchase-orders

HTTPcURLJavaScriptPython

PUT /purchase-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 556

{
  "comments": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "appointmentNumber": "text",
  "appointmentDate": "2026-03-02T18:47:36.301Z",
  "requiredDate": "2026-03-02T18:47:36.301Z",
  "dateCreated": "2026-03-02T18:47:36.301Z",
  "closeDate": "2026-03-02T18:47:36.301Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lines": [
    {
      "lineNumber": 1,
      "packsize": 1,
      "numberOfPacks": 1,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "orderedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete purchase order by code and clientId

delete

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

codestringOptional

clientIdstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

integer · int32Optional

406

Not Acceptable

text/plainapplication/jsontext/json

delete

/purchase-orders

HTTPcURLJavaScriptPython

DELETE /purchase-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

1

Upload an existing pending purchase orders

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

idsstring · uuid[] · nullableOptional

uploadedSuceededboolean · nullableOptional

uploadMessagestring · nullableOptional

resetUploadCountboolean · nullableOptional

Responses

200

OK

No content

406

Not Acceptable

text/plainapplication/jsontext/json

post

/purchase-orders/upload

HTTPcURLJavaScriptPython

POST /purchase-orders/upload HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "uploadedSuceeded": true,
  "uploadMessage": "text",
  "resetUploadCount": true
}

application/jsontext/jsonapplication/*+json

No content

Returns a single purchase order by id

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters

idstring · uuidRequired

Responses

200

OK

text/plainapplication/jsontext/json

commentsstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

appointmentNumberstring · nullableOptional

appointmentDatestring · date-time · nullableOptional

requiredDatestring · date-time · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

purchaseOrderNumberstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/purchase-orders/{id}

HTTPcURLJavaScriptPython

GET /purchase-orders/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "comments": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "appointmentNumber": "text",
  "appointmentDate": "2026-03-02T18:47:36.301Z",
  "requiredDate": "2026-03-02T18:47:36.301Z",
  "dateCreated": "2026-03-02T18:47:36.301Z",
  "closeDate": "2026-03-02T18:47:36.301Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "vendor": {
    "companyName": "text",
    "email": "text",
    "phone": "text",
    "contactPerson": "text",
    "description": "text",
    "address": {
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "client": {
      "description": "text",
      "ssccCompanyId": "text",
      "companyName": "text",
      "email": "text",
      "phone": "text",
      "contactPerson": "text",
      "taxId": "text",
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "vendorCode": "text"
  },
  "warehouse": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "warehouseCode": "text",
    "name": "text",
    "description": "text",
    "phone": "text",
    "email": "text",
    "referenceNumber": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "text"
  },
  "purchaseOrderNumber": "text",
  "lines": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lineNumber": 1,
      "product": {
        "description": "text",
        "upc": "text",
        "barcodeType": "Code128",
        "barcodeValue": "text",
        "referenceNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "client": {
          "description": "text",
          "ssccCompanyId": "text",
          "companyName": "text",
          "email": "text",
          "phone": "text",
          "contactPerson": "text",
          "taxId": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "stateProvince": "text",
          "zipPostalCode": "text",
          "country": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "sku": "text"
      },
      "orderedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text",
      "receivedQuantity": 1,
      "details": [
        {
          "receivedQuantity": 1,
          "lotNumber": "text",
          "serialNumber": "text",
          "expiryDate": "2026-03-02T18:47:36.301Z",
          "packsizeEachCount": 1
        }
      ]
    }
  ]
}

Delete purchase-order by Id

delete

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters

idstring · uuidRequired

Responses

200

OK

No content

406

Not Acceptable

text/plainapplication/jsontext/json

delete

/purchase-orders/{id}

HTTPcURLJavaScriptPython

DELETE /purchase-orders/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

No content

Returns a list of purchase orders by specified field/value

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters

fieldstringRequired

valuestringRequired

Responses

200

OK

text/plainapplication/jsontext/json

commentsstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

appointmentNumberstring · nullableOptional

appointmentDatestring · date-time · nullableOptional

requiredDatestring · date-time · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

purchaseOrderNumberstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/purchase-orders/{field}/{value}

HTTPcURLJavaScriptPython

GET /purchase-orders/{field}/{value} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "comments": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "appointmentNumber": "text",
  "appointmentDate": "2026-03-02T18:47:36.301Z",
  "requiredDate": "2026-03-02T18:47:36.301Z",
  "dateCreated": "2026-03-02T18:47:36.301Z",
  "closeDate": "2026-03-02T18:47:36.301Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "vendor": {
    "companyName": "text",
    "email": "text",
    "phone": "text",
    "contactPerson": "text",
    "description": "text",
    "address": {
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "client": {
      "description": "text",
      "ssccCompanyId": "text",
      "companyName": "text",
      "email": "text",
      "phone": "text",
      "contactPerson": "text",
      "taxId": "text",
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "vendorCode": "text"
  },
  "warehouse": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "warehouseCode": "text",
    "name": "text",
    "description": "text",
    "phone": "text",
    "email": "text",
    "referenceNumber": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "text"
  },
  "purchaseOrderNumber": "text",
  "lines": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lineNumber": 1,
      "product": {
        "description": "text",
        "upc": "text",
        "barcodeType": "Code128",
        "barcodeValue": "text",
        "referenceNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "client": {
          "description": "text",
          "ssccCompanyId": "text",
          "companyName": "text",
          "email": "text",
          "phone": "text",
          "contactPerson": "text",
          "taxId": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "stateProvince": "text",
          "zipPostalCode": "text",
          "country": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "sku": "text"
      },
      "orderedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text",
      "receivedQuantity": 1,
      "details": [
        {
          "receivedQuantity": 1,
          "lotNumber": "text",
          "serialNumber": "text",
          "expiryDate": "2026-03-02T18:47:36.301Z",
          "packsizeEachCount": 1
        }
      ]
    }
  ]
}