PUT /api/v1/shipping_lines/:code/bookings/:number/line_items/:line_item_number/flex_fields/:label
Updates a flex field for a booking line item

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/shipping_lines/SHIPPING_LINE_CODE/bookings/BOOKING_ID/line_items/LINE_ITEM_ID/flex_fields/LABEL" \
     -X PUT \
     "Authorization: Token token=ADD TOKEN HERE" \
     -d '{ "value": "FLEX_FIELD_VALUE" }'

{
  "label": "flex_field_label",
  "value": "FLEX_FIELD_VALUE"
}

Params

Param name Description
code
required

Shipping Line Code

Validations:

  • Must be a String
line_item_number
required

Line Item Number

Validations:

  • Must be a String
number
required

Booking Number

Validations:

  • Must be a String
label
required

Flex field label (case-sensitive).

Validations:

  • Must be a String
value
required

Flex field value. Passing a null value will remove the flex field.

Validations:

  • Must be a String