Outbound Bulk Order (B2B)

PUT /openapi/{version}/consignments/outbound_bulk_orders/{id}/

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:

curl --location --request PUT '{{url}}/openapi/v2/consignments/outbound_bulk_orders/1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your-auth-token>' \
--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
}''

Request

  • Base URL
    https://base_url
  • Auth
    none declared

Path parameters

idstring required
versionstring required

Request body

idinteger required
warehouse_idinteger

Warehouse ID

condition'USABLE' | 'UNUSABLE'
  • USABLE - USABLE
  • UNUSABLE - UNUSABLE
ship_by_locadboolean

Ship by Locad

start_timestring date-time required

Start Time

end_timestring date-time required

End Time

instructionstring

Instruction

carrier_namestring

Carrier name

tracking_numberstring

Tracking Number

max_allowed_instruction_lengthstring required

Max allowed instruction length

namestring

Name

phonestring

Phone number

carrier_tracking_codestring required

Carrier Tracking Code

warehouse_transferboolean

Warehouse Transfer

order_numstring 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_idinteger
packing_video_availableboolean nullable

Response

successboolean
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.