API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

shipping_shipments

Creates a shipping_shipments resource.

Creates a shipping_shipments resource.

Authorizations:
JWT
path Parameters
id
required
string

shipping_shipments identifier

Request Body schema:
required

The new shipping_shipments resource

invoice
string or null <iri-reference>
bill
string or null <iri-reference>
shipper
string or null <iri-reference>
location
string or null <iri-reference>
dateSend
required
string <date-time>
dateReceived
required
string <date-time>
batches
Array of strings <iri-reference> [ items <iri-reference > ]
trackingNumber
string or null
physicalIdentifier
string or null
trackingWebsite
string or null
notes
string or null
owningCorporation
string <iri-reference>
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customProperties
any

Can contain anything (array, objects, nested objects...).

customData
Array of strings or null
createdAt
string <date-time>
updatedAt
string <date-time>
disabledAt
string or null <date-time>
object (Collection.jsonld)
upload_filename
string
upload_subfolder
string
upload_file
string
upload_file_link
string
timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "invoice": "https://example.com/",
  • "bill": "https://example.com/",
  • "shipper": "https://example.com/",
  • "location": "https://example.com/",
  • "dateSend": "2019-08-24T14:15:22Z",
  • "dateReceived": "2019-08-24T14:15:22Z",
  • "batches": [],
  • "trackingNumber": "string",
  • "physicalIdentifier": "string",
  • "trackingWebsite": "string",
  • "notes": "string",
  • "owningCorporation": "https://example.com/",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": { },
  • "upload_filename": "string",
  • "upload_subfolder": "string",
  • "upload_file": "string",
  • "upload_file_link": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "upload_Subfolder": "string",
  • "upload_File": "string",
  • "upload_File_Link": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "invoice": {
    },
  • "bill": {
    },
  • "shipper": {
    },
  • "dateSend": "2019-08-24T14:15:22Z",
  • "dateReceived": "2019-08-24T14:15:22Z",
  • "trackingNumber": "string",
  • "physicalIdentifier": "string",
  • "trackingWebsite": "string",
  • "notes": "string",
  • "owningCorporation": {
    },
  • "shortcode": "S",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "locationListing": "string",
  • "batchesListing": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}