UpdateShipmentsExport

POST

/services/api/rest/UpdateShipmentsExport

Used for marking shipments and their invoices as Exported.

Error messages provided in the Errors object will be added to the shipment as Customer Provided note.

Request

Header Params

Content-Type

string

required

Example:

application/json

array[string]

optional

Example:

["application/json","application/xml"]

Body Params application/json

AuthenticationData

object (Authentication Data)

required

Banyan Credentials

Username

string

required

Banyan Username

Password

string

required

Banyan Password

ClientRefNum

string | null

optional

Client Reference Number - Used during multiple client integrations

Success

array [object {1}]

required

List of load Ids

<= 500 items

LoadId

integer

optional

Banyan's primary Shipment Identifier

Errors

array [object {2}]

required

List of load Ids and error messages

<= 500 items

LoadId

integer

optional

Banyan's primary Shipment Identifier

message

string

optional

Error message to be added as a note.

Example

{
    "AuthenticationData": {
        "Username": "username",
        "Password": "password",
        "ClientRefNum": ""
    },
    "Success": [
        {
            "LoadId": 3124442
        },
        {
            "LoadId": -58356682
        },
        {
            "LoadId": 80889175
        }
    ],
    "Errors": [
        {
            "LoadId": -75669776,
            "message": "Veniam dolorem facere eveniet occaecati quo quo unde quos dicta. Dicta accusamus assumenda occaecati omnis saepe totam.."
        },
        {
            "LoadId": -21322974,
            "message": "Magnam sint officia assumenda asperiores quod itaque. In exercitationem vitae quidem aliquam facere eos eius."
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ws.integration.banyantechnology.com/services/api/rest/UpdateShipmentsExport' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AuthenticationData": {
        "Username": "username",
        "Password": "password",
        "ClientRefNum": ""
    },
    "Success": [
        {
            "LoadId": 3124442
        },
        {
            "LoadId": -58356682
        },
        {
            "LoadId": 80889175
        }
    ],
    "Errors": [
        {
            "LoadId": -75669776,
            "message": "Veniam dolorem facere eveniet occaecati quo quo unde quos dicta. Dicta accusamus assumenda occaecati omnis saepe totam.."
        },
        {
            "LoadId": -21322974,
            "message": "Magnam sint officia assumenda asperiores quod itaque. In exercitationem vitae quidem aliquam facere eos eius."
        }
    ]
}'

Responses

🟢200UpdateShipmentsExport

application/json

Body

ProcessedLoadIds

array[integer]

required

The Load Ids that were successfully processed.

InvalidLoadIds

array[integer]

required

The Load Ids that were not able to be processed.

Errors

array[string]

required

A list containing any errors that occurred

Success

boolean

required

Whether request was successful

Example

{
    "ProcessedLoadIds": [
        16128483
    ],
    "InvalidLoadIds": [
        64785449
    ],
    "Errors": [
        ""
    ],
    "Success": true
}

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

UpdateLoadStatus

PendingImport