Adds one or more Reference Numbers to a Shipment

POST

/api/v3/shipments/{Id}/referencenumbers

Shipments

Adds reference numbers to the specified Shipment by its id.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

integer

required

The Id of the entity the request relates to.

Body Params application/json

The create reference number request.

referenceFields

array[object (ReferenceFieldDto) {4}]

required

The reference fields to create.

>= 1 items

type

string

required

The type of the Reference field

>= 1 characters<= 250 characters

value

string

required

The actual value of the Reference field

>= 1 characters<= 250 characters

printOnBol

boolean

optional

If true, this reference field will be printed on the shipments BOL

printOnShippingLabel

boolean

optional

If true, this reference field will be printed on the shipments Shipping Label

Example

{
    "referenceFields": [
        {
            "type": "string",
            "value": "string",
            "printOnBol": true,
            "printOnShippingLabel": true
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ws.integration.banyantechnology.com/api/v3/shipments//referencenumbers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referenceFields": [
        {
            "type": "string",
            "value": "string",
            "printOnBol": true,
            "printOnShippingLabel": true
        }
    ]
}'

Responses

🟢200Success

application/json

Body

array of:

type

string

required

The type of the Reference field

>= 1 characters<= 250 characters

value

string

required

The actual value of the Reference field

>= 1 characters<= 250 characters

printOnBol

boolean

optional

If true, this reference field will be printed on the shipments BOL

printOnShippingLabel

boolean

optional

If true, this reference field will be printed on the shipments Shipping Label

Example

[
    {
        "type": "string",
        "value": "string",
        "printOnBol": true,
        "printOnShippingLabel": true
    }
]

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠429Too Many Requests

Modified at 2024-09-16 11:42:17

Update a Shipment

Mark as Exported

Adds one or more Reference Numbers to a Shipment

Adds reference numbers to the specified Shipment by its id.#

Request

Request samples

Responses

Adds reference numbers to the specified Shipment by its id.