Adds one or more Reference Numbers to a Shipment

POST

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

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

Body Params application/json

Example

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

Request Code 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

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 Code Samples

Responses

Adds reference numbers to the specified Shipment by its id.