Customizable fields for Bill of Ladings

Supported Formats

json

PUT /api/v1/manifests/:manifest_client_identifier/bill_of_ladings/:bill_of_lading_number/flex_fields/:label
Updates the flex field

This endpoint allows you to update flex fields for bill of ladings on Octopi.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Not Found.
422 Unprocessable Entity.
500 Internal Server Error.

Examples

curl "https://app.octopi.co/api/v1/manifests/CLIENT_IDENTIFIER/bill_of_ladings/NUMBER/flex_fields/LABEL" \
     -X PUT \
     "Authorization: Token token=ADD TOKEN HERE" \
     -d '{ "value": "FLEX_FIELD_VALUE" }'
"value": "FLEX_FIELD_VALUE" 

Params

Param name Description
manifest_client_identifier
required

Client identifier for the manifest

Validations:

  • Must be a String

bill_of_lading_number
required

Number of the Bill of Ladings

Validations:

  • Must be a String

label
required

Label of the flex field

Validations:

  • Must be a String

value
required

Value of the flex field to change

Validations:

  • Must be a String