API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

shipping_shipments

Retrieves the collection of shipping_shipments resources.

Retrieves the collection of shipping_shipments resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[invoice]
boolean
exists[bill]
boolean
exists[shipper]
boolean
exists[location]
boolean
exists[batches]
boolean
exists[trackingNumber]
boolean
exists[physicalIdentifier]
boolean
exists[trackingWebsite]
boolean
exists[notes]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[dateSend]
string
Default: "asc"
Enum: "asc" "desc"
order[dateReceived]
string
Default: "asc"
Enum: "asc" "desc"
order[trackingNumber]
string
Default: "asc"
Enum: "asc" "desc"
order[physicalIdentifier]
string
Default: "asc"
Enum: "asc" "desc"
order[trackingWebsite]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
bill
string
bill[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
dateReceived[before]
string
dateReceived[strictly_before]
string
dateReceived[after]
string
dateReceived[strictly_after]
string
dateSend[before]
string
dateSend[strictly_before]
string
dateSend[after]
string
dateSend[strictly_after]
string
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
invoice
string
invoice[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
physicalIdentifier_end_with
string
physicalIdentifier_partial
string
physicalIdentifier_start_with
string
physicalIdentifier
string
physicalIdentifier[]
Array of strings
shipper
string
shipper[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
trackingNumber_end_with
string
trackingNumber_partial
string
trackingNumber_start_with
string
trackingNumber
string
trackingNumber[]
Array of strings
trackingWebsite_end_with
string
trackingWebsite_partial
string
trackingWebsite_start_with
string
trackingWebsite
string
trackingWebsite[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}