Update BOL for Order

Request

Path Params

businessUnitId

string

required

customerOrderNumber

string

required

Body Params application/json

data

object (TmsShipmentBookAsyncResponse)

optional

This will update the TMS booking information for the order. If a partial payload os provided, then only those fields should be updated. e.g. If we pass only proNumber, then only that value should be updated while the rest of the BOL data should remain unchanged.

proNumber

string

optional

This is optional and may be provided later

base64String

string

required

sourceSystem

enum<string>

optional

Allowed values:

KUEBIXCOYOTEFREIGHT_CLUB

messageType

string

optional

Srini said this is a "Book Flavor". Need clarification.

loadNumber

string

optional

carrierCode

string

optional

serviceLevel

string

optional

totalPrice

string

optional

bolNumber

string

optional

requestedShipDate

string <date-time>

optional

The latest date-time the order should ship by

deliveryStartDate

string <date-time>

optional

Beginning of date-time window in which delivery arrives at destination

deliveryEndDate

string <date-time>

optional

End of date-time window in which delivery arrives at destination

Example

{
    "data": {
        "proNumber": "string",
        "base64String": "string",
        "sourceSystem": "KUEBIX",
        "messageType": "string",
        "loadNumber": "string",
        "carrierCode": "string",
        "serviceLevel": "string",
        "totalPrice": "string",
        "bolNumber": "string",
        "requestedShipDate": "2019-08-24T14:15:22Z",
        "deliveryStartDate": "2019-08-24T14:15:22Z",
        "deliveryEndDate": "2019-08-24T14:15:22Z"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT '/business_units//sales_orders//tms_book' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "proNumber": "string",
        "base64String": "string",
        "sourceSystem": "KUEBIX",
        "messageType": "string",
        "loadNumber": "string",
        "carrierCode": "string",
        "serviceLevel": "string",
        "totalPrice": "string",
        "bolNumber": "string",
        "requestedShipDate": "2019-08-24T14:15:22Z",
        "deliveryStartDate": "2019-08-24T14:15:22Z",
        "deliveryEndDate": "2019-08-24T14:15:22Z"
    }
}'

Responses

🟢200OK

application/json

Body

object {0}

Example

{}