StartWaterfallTendering

POST

/services/api/rest/StartWaterfallTendering

This function will start Waterfall Tendering for given load.

Request

Header Params

Content-Type

string

required

Example:

application/json

string

optional

Example:

application/json

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

LoadId

integer

required

Banyan's primary Shipment Identifier

Example

{
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "LoadID":"12345678"
}

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/StartWaterfallTendering' \
--header 'Content-Type: application/json' \
--data-raw '{
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "LoadID":"12345678"
}'

Responses

🟢200Success

application/json

Body

success

boolean

required

Whether or not the request was successful.

error

object (ErrorObject)

optional

An object containing any errors

Message

string

required

Example

{
    "success": true,
    "error": {
        "Message": "string"
    }
}

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

EzRate_Sync

CancelWaterfallTendering