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

Body Params application/json

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

Example

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

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

UpdateLoadStatus

PendingImport