- Version 3
- Authentication
- Shipments
- Invoice
- Tracking
- StaticData
- Authentication
- Version 2
- Exports and Webhooks
UpdateShipmentsExport
POST
/services/api/rest/UpdateShipmentsExport
Request
Header Params
Content-Type
string
required
Example:
application/json
Accept
array[string]
optional
Example:
["application/json","application/xml"]
Body Params application/json
AuthenticationData
object (Authentication Data)
required
Username
string
required
Password
string
required
ClientRefNum
string | null
optional
Success
array [object {1}]
required
<= 500 items
LoadId
integer
optional
Errors
array [object {2}]
required
<= 500 items
LoadId
integer
optional
message
string
optional
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
InvalidLoadIds
array[integer]
required
Errors
array[string]
required
Success
boolean
required
Example
{
"ProcessedLoadIds": [
16128483
],
"InvalidLoadIds": [
64785449
],
"Errors": [
""
],
"Success": true
}
Modified at 2024-09-16 11:42:17