TRtrackstarhq
erp
Purchase Order Receipts

Get All ERP Purchase Order Receipts

Changed on

Returns all Purchase Order Receipts for the ERP connection associated with the provided access token. Receipts are goods-receipt events recorded against a parent purchase order; the parent is linked via purchase_order_id.

get/erp/purchase-order-receipts

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/erp/purchase-order-receipts
  • Auth
    none required

Query parameters

page_tokenstring nullable
Example:page_token

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

limitinteger
Example:1000

The maximum number of items to return. The default is 1000.

instring[] required

A comma-separated list of resource IDs. If provided, all other query params are ignored.

{
  "in": [
    "_in"
  ]
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. Note: it is much more efficient to use a combination of gte/lte than it is to use gt/lt.

{
  "eq": "2023-03-15T13:45:30Z",
  "neq": "2023-03-15T13:45:30Z",
  "in": [
    "2023-03-15T13:45:30Z"
  ],
  "nin": [
    "2023-03-15T13:45:30Z"
  ],
  "gt": "2023-03-15T13:45:30Z",
  "gte": "2023-03-15T13:45:30Z",
  "lt": "2023-03-15T13:45:30Z",
  "lte": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z",
  "neq": "2023-03-15T13:45:30Z",
  "in": [
    "2023-03-15T13:45:30Z"
  ],
  "nin": [
    "2023-03-15T13:45:30Z"
  ],
  "gt": "2023-03-15T13:45:30Z",
  "gte": "2023-03-15T13:45:30Z",
  "lt": "2023-03-15T13:45:30Z",
  "lte": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z",
  "neq": "2023-03-15T13:45:30Z",
  "in": [
    "2023-03-15T13:45:30Z"
  ],
  "nin": [
    "2023-03-15T13:45:30Z"
  ],
  "gt": "2023-03-15T13:45:30Z",
  "gte": "2023-03-15T13:45:30Z",
  "lt": "2023-03-15T13:45:30Z",
  "lte": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z",
  "neq": "2023-03-15T13:45:30Z",
  "in": [
    "2023-03-15T13:45:30Z"
  ],
  "nin": [
    "2023-03-15T13:45:30Z"
  ],
  "gt": "2023-03-15T13:45:30Z",
  "gte": "2023-03-15T13:45:30Z",
  "lt": "2023-03-15T13:45:30Z",
  "lte": "2023-03-15T13:45:30Z"
}
containsstring[]

Comma-separated.

not_containsstring[]

Comma-separated.

Filter by trackstar tags. Dict-shaped tags should be queried as "key:value" strings. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, purchase_order_id, receipt_number) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.

{
  "contains": [
    "contains"
  ],
  "not_contains": [
    "not_contains"
  ]
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

ID of the parent purchase order.

{
  "eq": "po_id",
  "neq": "neq",
  "in": [
    "_in"
  ],
  "nin": [
    "nin"
  ]
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

A user-facing identifier for the receipt.

{
  "eq": "RCPT1001",
  "neq": "neq",
  "in": [
    "_in"
  ],
  "nin": [
    "nin"
  ],
  "contains": "contains",
  "not_contains": "not_contains"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

The date the receipt was recorded. Same syntax as created_date/updated_date. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, purchase_order_id, receipt_number) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.

{
  "eq": "2024-05-08T00:00:00Z",
  "neq": "2023-03-15T13:45:30Z",
  "in": [
    "2023-03-15T13:45:30Z"
  ],
  "nin": [
    "2023-03-15T13:45:30Z"
  ],
  "gt": "2023-03-15T13:45:30Z",
  "gte": "2023-03-15T13:45:30Z",
  "lt": "2023-03-15T13:45:30Z",
  "lte": "2023-03-15T13:45:30Z"
}

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Response

Successful response

next_tokenstring nullable required

See pagination for more details.

total_countinteger required

The number of items returned.

Example response

{
  "data": [
    {
      "id": "rcpt_1",
      "purchase_order_id": "po_id",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "receipt_number": "RCPT1001",
      "received_date": "2024-05-08T00:00:00Z",
      "location_id": "loc_1",
      "notes": [
        "First partial"
      ],
      "line_items": [
        {
          "receipt_line_item_id": "receipt_line_item_id",
          "line_item_id": "line_item_id",
          "item_id": "item_id",
          "sku": "sku",
          "quantity": 0,
          "lot_id": "lot_id",
          "lot_name": "lot_name",
          "expiration_date": "2023-03-15T13:45:30Z",
          "bin_id": "bin_id",
          "bin_name": "bin_name"
        }
      ],
      "custom_fields": {
        "custom_field_example": {
          "value": "example_value",
          "type": "string",
          "title": "Example Field"
        }
      },
      "external_system_url": "https://example.com/purchaseorderreceipt/123",
      "trackstar_tags": [
        "tag1",
        "tag2",
        {
          "tag3": "value3"
        }
      ],
      "additional_fields": {
        "key": "value"
      },
      "trackstar_created_date": "2023-03-15T13:45:30Z",
      "trackstar_updated_date": "2023-03-15T13:45:30Z"
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Changes