--- title: "PUT /openapi/{version}/consignments/outbound_bulk_orders/{id}/" method: PUT path: "/openapi/{version}/consignments/outbound_bulk_orders/{id}/" tags: ["Outbound Bulk Order (B2B)"] --- # PUT /openapi/{version}/consignments/outbound_bulk_orders/{id}/ `PUT /openapi/{version}/consignments/outbound_bulk_orders/{id}/` ## Request - Base URL: `https://base_url` - URL: `https://base_url/openapi/{version}/consignments/outbound_bulk_orders/{id}/` - Auth: none declared This endpoint allows users to update an existing outbound bulk order by specifying the updated order details. Example `curl` Request: To update an existing outbound bulk order with the ID `1`, use the following `curl` request: ```bash curl --location --request PUT '{{url}}/openapi/v2/consignments/outbound_bulk_orders/1' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ' \ --data '{ "warehouse_id": 0, "condition": "USABLE", "ship_by_locad": true, "start_time": "2024-11-14T14:15:22Z", "end_time": "2024-11-14T14:15:22Z", "instruction": "Handle with care, fragile items", "carrier_name": "DHL", "tracking_number": "DHL1223333", "address": { "address_reference_name": "Singapore Distribution Center", "address": { "address_line1": "789 Delivery Rd", "address_line2": "Suite 2B", "address_line3": "", "phone": "+65 12345678", "city": "Singapore", "state": "Singapore", "country": "SG", "suburb": "Central", "zipcode": "678910", "email": "john.doe@example.com" }, "channel_id": 1, "channel_code": "SG-DC" }, "name": "John Doe", "phone": "+65 98765432", "warehouse_transfer": false, "order_items": [ { "inventory_product": "Product456", "quantity": 50, "instruction": "Keep in cool storage" } ], "destination_address_id": 123 }'' ``` ## Path parameters - `id` string, required - `version` string, required ## Request body - OutboundBulkOrderUpdateOpenAPI - `id` integer, required - `warehouse_id` integer: Warehouse ID - `warehouse` WarehouseOpenAPI, required - `id` integer, required - `name` string, required - `code` string, nullable - `address` WarehouseAddressOpenAPI, required - `first_name` string, required: Name - `last_name` string - `address_line1` string, required: Address line 1 - `address_line2` string, nullable: Address line 2 - `address_line3` string, nullable: Address line 3 - `email` string - `phone` string - `city` string, required: City - `state` string, required: State - `country` string, required: Country - `locality` string, required: Locality (barangay or suburb) - `zipcode` string, required: Zipcode - `pickup_location_id` integer, required: Pickup location id - `condition` 'USABLE' | 'UNUSABLE': * `USABLE` - USABLE * `UNUSABLE` - UNUSABLE - `history_lines` OutboundBulkOrderStatusHistoryOpenAPI[], required: History Lines - `old_status` string, required: Old Status - `new_status` string, required: New Status - `source` string, required: Source - `change_detail` string, required: Change Detail - `event_on` string, date-time, required: Event On - `ship_by_locad` boolean: Ship by Locad - `start_time` string, date-time, required: Start Time - `end_time` string, date-time, required: End Time - `instruction` string: Instruction - `carrier_name` string: Carrier name - `tracking_number` string: Tracking Number - `max_allowed_instruction_length` string, required: Max allowed instruction length - `sla_attrs` OutboundBulkOrderSlaTimesOpenAPI[], required: Sla Times - `submitted_at` string, date-time, required: Submitted At - `picked_at` string, date-time, required: Picked At - `packed_at` string, date-time, required: Packed At - `ready_for_dispatch_at` string, date-time, required: Ready For Dispatch At - `dispatched_at` string, date-time, required: Dispatched At - `completed_at` string, date-time, required: Completed At - `address` BulkOrderBrandDestinationAddressOpenAPI - `address_reference_name` string - `address` BulkOrderAddressOpenAPI - `address_line1` string, required: Address line 1 - `address_line2` string: Address line 2 - `address_line3` string: Address line 3 - `email` string - `phone` string - `city` string, required: City - `state` string, required: State - `country` string, required: Country - `suburb` string: Suburb - `zipcode` string, required: Zipcode - `channel` BulkOrderChannelOpenAPI, required - `id` integer, required: Id for bulk outbound order channel - `channel_name` string, required: Channel name for bulk outbound order channel - `channel_code` string, required: Channel code for bulk outbound order channel - `channel_desc` string, required: Channel Description for bulk outbound order channel - `channel_id` integer: Either channel_id or channel_code must be provided. If both are given, channel_id must match the given channel_code. - `channel_code` string: Channel Code (Seller defined. We will create a channel if not exists already), note that either channel_id or channel_code must be provided. If both are given, channel_id must match the given channel_code. - `name` string: Name - `phone` string: Phone number - `carrier_tracking_code` string, required: Carrier Tracking Code - `warehouse_transfer` boolean: Warehouse Transfer - `order_items` OutboundBulkOrderItemOpenAPI[]: Order Items - `inventory_product` string, required: inventory product sku - `quantity` integer, required: quantity - `instruction` string, required: instruction - `packed_quantity` integer, required: packed quantity - `active` boolean, required - `id` integer, required - `order_num` string, required: Order Number - `status` 'CANCELLED' | 'COMPLETED' | 'CONFIRMED' | 'DISPATCHED' | 'DRAFT' | 'ERROR' | 'FAILED_DELIVERY' | 'PACKING' | 'PARTIAL' | 'PICKED' | 'PICKING' | 'READY_FOR_DISPATCH' | 'READY_FOR_PICKING' | 'RETURNED' | 'UNKNOWN' | 'UNPAID', required: * `CANCELLED` - CANCELLED * `COMPLETED` - COMPLETED * `CONFIRMED` - CONFIRMED * `DISPATCHED` - DISPATCHED * `DRAFT` - DRAFT * `ERROR` - ERROR * `FAILED_DELIVERY` - FAILED_DELIVERY * `PACKING` - PACKING * `PARTIAL` - PARTIAL * `PICKED` - PICKED * `PICKING` - PICKING * `READY_FOR_DISPATCH` - READY_FOR_DISPATCH * `READY_FOR_PICKING` - READY_FOR_PICKING * `RETURNED` - RETURNED * `UNKNOWN` - UNKNOWN * `UNPAID` - UNPAID - `destination_address_id` integer - `packing_video_available` boolean, nullable ## Response `200` - EnvelopedOutboundBulkOrderUpdateOpenAPI - `success` boolean - `data` OutboundBulkOrderUpdateOpenAPI, required - `id` integer, required - `warehouse_id` integer: Warehouse ID - `warehouse` WarehouseOpenAPI, required - `id` integer, required - `name` string, required - `code` string, nullable - `address` WarehouseAddressOpenAPI, required - `first_name` string, required: Name - `last_name` string - `address_line1` string, required: Address line 1 - `address_line2` string, nullable: Address line 2 - `address_line3` string, nullable: Address line 3 - `email` string - `phone` string - `city` string, required: City - `state` string, required: State - `country` string, required: Country - `locality` string, required: Locality (barangay or suburb) - `zipcode` string, required: Zipcode - `pickup_location_id` integer, required: Pickup location id - `condition` 'USABLE' | 'UNUSABLE': * `USABLE` - USABLE * `UNUSABLE` - UNUSABLE - `history_lines` OutboundBulkOrderStatusHistoryOpenAPI[], required: History Lines - `old_status` string, required: Old Status - `new_status` string, required: New Status - `source` string, required: Source - `change_detail` string, required: Change Detail - `event_on` string, date-time, required: Event On - `ship_by_locad` boolean: Ship by Locad - `start_time` string, date-time, required: Start Time - `end_time` string, date-time, required: End Time - `instruction` string: Instruction - `carrier_name` string: Carrier name - `tracking_number` string: Tracking Number - `max_allowed_instruction_length` string, required: Max allowed instruction length - `sla_attrs` OutboundBulkOrderSlaTimesOpenAPI[], required: Sla Times - `submitted_at` string, date-time, required: Submitted At - `picked_at` string, date-time, required: Picked At - `packed_at` string, date-time, required: Packed At - `ready_for_dispatch_at` string, date-time, required: Ready For Dispatch At - `dispatched_at` string, date-time, required: Dispatched At - `completed_at` string, date-time, required: Completed At - `address` BulkOrderBrandDestinationAddressOpenAPI - `address_reference_name` string - `address` BulkOrderAddressOpenAPI - `address_line1` string, required: Address line 1 - `address_line2` string: Address line 2 - `address_line3` string: Address line 3 - `email` string - `phone` string - `city` string, required: City - `state` string, required: State - `country` string, required: Country - `suburb` string: Suburb - `zipcode` string, required: Zipcode - `channel` BulkOrderChannelOpenAPI, required - `id` integer, required: Id for bulk outbound order channel - `channel_name` string, required: Channel name for bulk outbound order channel - `channel_code` string, required: Channel code for bulk outbound order channel - `channel_desc` string, required: Channel Description for bulk outbound order channel - `channel_id` integer: Either channel_id or channel_code must be provided. If both are given, channel_id must match the given channel_code. - `channel_code` string: Channel Code (Seller defined. We will create a channel if not exists already), note that either channel_id or channel_code must be provided. If both are given, channel_id must match the given channel_code. - `name` string: Name - `phone` string: Phone number - `carrier_tracking_code` string, required: Carrier Tracking Code - `warehouse_transfer` boolean: Warehouse Transfer - `order_items` OutboundBulkOrderItemOpenAPI[]: Order Items - `inventory_product` string, required: inventory product sku - `quantity` integer, required: quantity - `instruction` string, required: instruction - `packed_quantity` integer, required: packed quantity - `active` boolean, required - `id` integer, required - `order_num` string, required: Order Number - `status` 'CANCELLED' | 'COMPLETED' | 'CONFIRMED' | 'DISPATCHED' | 'DRAFT' | 'ERROR' | 'FAILED_DELIVERY' | 'PACKING' | 'PARTIAL' | 'PICKED' | 'PICKING' | 'READY_FOR_DISPATCH' | 'READY_FOR_PICKING' | 'RETURNED' | 'UNKNOWN' | 'UNPAID', required: * `CANCELLED` - CANCELLED * `COMPLETED` - COMPLETED * `CONFIRMED` - CONFIRMED * `DISPATCHED` - DISPATCHED * `DRAFT` - DRAFT * `ERROR` - ERROR * `FAILED_DELIVERY` - FAILED_DELIVERY * `PACKING` - PACKING * `PARTIAL` - PARTIAL * `PICKED` - PICKED * `PICKING` - PICKING * `READY_FOR_DISPATCH` - READY_FOR_DISPATCH * `READY_FOR_PICKING` - READY_FOR_PICKING * `RETURNED` - RETURNED * `UNKNOWN` - UNKNOWN * `UNPAID` - UNPAID - `destination_address_id` integer - `packing_video_available` boolean, nullable - `message` string, required ## Other responses - `400`: Bad Request - Invalid input. - `401`: Unauthorized - Invalid or expired credentials. - `403`: Forbidden - You do not have permission to access this resource. - `404`: Not Found - The requested resource does not exist. - `500`: Internal Server Error - Unexpected error occurred. --- [API](https://skmtc.dev/golocad/apis/locad-api.md) - [All operations](https://skmtc.dev/golocad/apis/locad-api/llms.txt) - [OpenAPI document](https://skmtc.dev/golocad/apis/locad-api/revisions/428200f33a81?raw)