Query up to 500 parcels.

Request

Query Params

AfterId

integer <int64> | null

optional

Take records after specified parcel id. Optional.

Count

integer <int32> | null

optional

Number of records in response, default 500, max 500. Optional.

Example:

3

CreatedAfter

string <date-time> | null

optional

Take records created after specified date/time. Optional.

CreatedBefore

string <date-time> | null

optional

Take records created before specified date/time. Optional.

ShipmentId

integer <int64> | null

optional

Take records linked to specified shipment id. Optional.

Type

string | null

optional

Take records of specified type. Optional.
Registered, NotRegistered, Prime

Example:

NotRegistered

Status

enum<string>

optional

Take records of specified status. Optional.

Allowed values:

CreatedImportedManifestedDeleted

ShipmentType

string | null

optional

Take records linked to shipments of specified type. Optional.

ShipmentStatus

enum<string>

optional

Take records linked to shipments of specified status. Optional.

Allowed values:

ImportedCreatedManifested

ManifestFileId

integer <int64> | null

optional

Take records linked to specified manifest file id. Optional.

IncludeReceiver

boolean

optional

Whether parcel receiver information should be included in the response

IncludeSender

boolean

optional

Whether parcel sender information should be included in the response

IncludeItems

boolean

optional

Whether parcel items information should be included in the response

IncludePrints

boolean

optional

Whether parcel prints information should be included in the response

Header Params

Content-Type

string

optional

Default:

application/json

Accept

string

optional

Default:

application/json

X-API-KEY

string

optional

Default:

apitest1234567890

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.test.post-plus.io/api/v1/parcels/query?AfterId&Count=3&CreatedAfter&CreatedBefore&ShipmentId&Type=NotRegistered&Status&ShipmentType&ShipmentStatus&ManifestFileId&IncludeReceiver&IncludeSender&IncludeItems&IncludePrints' \
--header 'Accept: application/json' \
--header 'X-API-KEY: apitest1234567890' \
--header 'Content-Type: application/json'

Responses

🟢200OK

text/plain

Success

Body

lastId

integer <int64> | null

optional

details

array[object (ParcelDetailsResponse) {8}] | null

optional

identifiers

object (ParcelIdentifiers)

optional

references

object (ParcelReferences)

optional

status

object (ParcelStatusInfo)

optional

parcel

object (ParcelInfo)

optional

receiver

object (ParcelReceiverInfo)

optional

sender

object (ParcelSenderInfo)

optional

additionalInfo

object (ParcelAdditionalInfo)

optional

prints

array[object (ParcelPrintInfo) {9}] | null

optional

Example

{
  "lastId": 0,
  "details": [
    {
      "identifiers": {
        "id": 1234,
        "parcelNr": "RS12345678US",
        "senderParcelNr": "client-id-123"
      },
      "references": {
        "shipmentId": 0,
        "shipmentNr": "123-000000123",
        "bagNr": "bag-001",
        "externalIds": 1234567890,
        "carrier": "string",
        "carrierParcelNr": "string",
        "manifestParcelNr": "string",
        "printId": 1234567890
      },
      "status": {
        "hasErrors": true,
        "errorDetails": [
          "string"
        ],
        "hasWarnings": true,
        "isCancelled": false,
        "warningDetails": [
          "string"
        ],
        "status": "Created",
        "createdOn": "2019-08-24T14:15:22Z"
      },
      "parcel": {
        "type": "NotRegistered",
        "destinationCountryCode": "NL",
        "transactionType": "B2C",
        "parcelItems": 1,
        "parcelValue": 1.25,
        "currency": "USD",
        "parcelGrossWeight": 0.125,
        "height": 0,
        "width": 0,
        "length": 0,
        "items": [
          {
            "description": "Tennis ball",
            "skuCode": "sku-123",
            "hsCode": "711319",
            "quantity": 1,
            "valuePerItem": 1.25,
            "weightPerItem": 0.125
          }
        ]
      },
      "receiver": {
        "name": "string",
        "phone": "string",
        "phoneNormalized": "string",
        "email": "string",
        "address": "string",
        "zipCode": "string",
        "city": "string",
        "state": "string",
        "countryCode": "string",
        "pickupPointId": 0
      },
      "sender": {
        "name": "string",
        "phone": "string",
        "phoneNormalized": "string",
        "email": "string",
        "address": "string",
        "zipCode": "string",
        "city": "string",
        "state": "string",
        "countryCode": "string"
      },
      "additionalInfo": {
        "taxType": "string",
        "taxIdentification": "string",
        "routeInfo": "string",
        "shipDate": "2019-08-24T14:15:22Z",
        "serviceCode": "string",
        "ordinal": 0
      },
      "prints": [
        {
          "id": 1234,
          "format": "Pdf",
          "type": "PostalLabel",
          "subTypes": [
            "string"
          ],
          "provider": "ExtProvider,Postal",
          "bytes": 0,
          "content": "string",
          "hasErrors": true,
          "errorDetails": [
            "string"
          ]
        }
      ]
    }
  ]
}