PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

shipping_shippers

Retrieves a shipping_shippers resource.

Retrieves a shipping_shippers resource.

Authorizations:
JWT
path Parameters
id
required
string

shipping_shippers identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "person": {
    },
  • "code": "string",
  • "accountNumber": "string",
  • "notes": "string",
  • "owningCorporation": {
    },
  • "shortcode": "TR",
  • "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",
  • "shipmentsListing": "string",
  • "clientsListing": "string",
  • "suppliersListing": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the shipping_shippers resource.

Replaces the shipping_shippers resource.

Authorizations:
JWT
path Parameters
id
required
string

shipping_shippers identifier

Request Body schema:
required

The updated shipping_shippers resource

required
object (people.jsonld-add_post)

Get person.

code
string or null
accountNumber
string or null
notes
string or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "person": {
    },
  • "code": "string",
  • "accountNumber": "string",
  • "notes": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "person": {
    },
  • "code": "string",
  • "accountNumber": "string",
  • "notes": "string",
  • "owningCorporation": {
    },
  • "shortcode": "TR",
  • "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",
  • "shipmentsListing": "string",
  • "clientsListing": "string",
  • "suppliersListing": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the shipping_shippers resource.

Removes the shipping_shippers resource.

Authorizations:
JWT
path Parameters
id
required
string

shipping_shippers identifier

Responses