Create Order

This method is used to create draft freight orders that can be viewed from the open orders page in the dashboard.

Endpoint

Method URI Headers
POST freight-orders default

Request

Field Required Type Description
shipment_order_id No* Integer This field is used for updating existing shipment order. If not provided, system will generate a new one.
pickup_date Yes String Proposed pickup date, in Y-m-d
from_opening_time Yes String Opening time of pickup address, in H:i
from_closing_time Yes String Closing time of pickup address, in H:i
from_instructions No String Any special instructions for the pickup address
from_address {} Yes Object Sender address container, not required if a "from_address_id" was used
+name Yes String Name of the sender
+attention No String Attention of the sender
+street_1 Yes String Street line 1
+street_2 No String Street line 2
+street_3 No String Street line 3
+city Yes String City
+zip Yes String Postal Zip code
+state No* String State - This field is required for US or Canada addresses please refer to country-codes
+country Yes String Country (code) for the list please refer to country-codes
+telephone Yes String Telephone Number (10-15 digits)
+lift_gate No Boolean Default value is false
+residential No Boolean Default value is false
+inside No Boolean Default value is false
+limited_access No Boolean Default value is false
+appointment No Boolean Default value is false
to_opening_time Yes String Opening time of delivery address, in H:i
to_closing_time Yes String Closing time of delivery address, in H:i
to_address {} Yes Object Receiver address container
+name Yes String Name of the receiver
+attention No String Attention of the receiver
+street_1 Yes String Street line 1
+street_2 No String Street line 2
+street_3 No String Street line 3
+city Yes String City
+zip Yes String Postal Zip code
+state No* String State - This field is required for US or Canada addresses please refer to country-codes
+country Yes String Country (code) for the list please refer to country-codes
+telephone Yes String Telephone Number (10-15 digits)
+lift_gate No Boolean Default value is false
+residential No Boolean Default value is false
+inside No Boolean Default value is false
+limited_access No Boolean Default value is false
+appointment No Boolean Default value is false
items [] Yes Array An array containing all the information about items
+count Yes Integer Pieces count
+package_type No String Default value is "pallet_48x40". For a full list please check out freight packages
+length Yes Float Length (IN) - If selected package type has forced length this field will be overwritten with forced length
+width Yes Float Width (IN) - If selected package type has forced width this field will be overwritten with forced width
+height Yes Float Height (IN)
+weight Yes Float Weight (LBS)
+description Yes String Description of the item
+price No* Float Price (Commodity Value) of the item Condition:required only if insurance is selected
+is_hazmat No String If the item is hazmat, default is false
+is_used_items No String If the item is used or new, default is false
+is_stackable No String If the item is stackable, default is false
+freight_class No String Preferred freight class, default is auto where we calculate the class automatically (recommended), for options please check freight classes
+sku No String PO number of the shipment

Request Example

{
    "pickup_date": "2022-05-25",
    "from_opening_time": "08:00",
    "from_closing_time": "17:00",
    "from_instructions": "Walk in",

    "from_address": {
        "name": "Acme Corp",
        "attention": "Jane Doe",
        "city": "Los Angeles",
        "street_1": "123 S Main St",
        "zip": "90012",
        "state": "CA",
        "country": "US",
        "telephone": "9999999999"
    },

    "to_opening_time": "08:00",
    "to_closing_time": "17:00",
    "to_instructions": "Wait at the gate",
    "to_address": {
        "name": "Example Corp",
        "attention": "John Doe",
        "city": "Flushing",
        "street_1": "123 Main St",
        "zip": "11354",
        "state": "NY",
        "country": "US",
        "telephone": "9999999999"
    },
    "items": [
        {
            "package_type": "pallet_48x40",
            "count": 1,
            "length": "48",
            "width": "40",
            "height": "50",
            "weight": "100",
            "sku": null,
            "description": "Some Description"
        }
    ]
}

Response

Field Type Description
success Boolean true or false
message String Message
data Object Shipment order id container
+shipment_order_id Integer This is the id of your shipment

Response Examples

Successful

{
    "success": true,
    "data": {
        "shipment_order_id": 123123123
    },
    "message": "Freight Order created"
}

Failed

{
    "success": false,
    "message": "The given data was invalid.",
    "data": {
        "to_address.city": [
            "The to address.city field is required."
        ]
    }
}