Mark As Shipped

This method is used to mark draft orders as shipped without sending them through deftship

Endpoint

Method URI Headers
POST mark-as-shipped default

Request

Field Required Type Description
send_fulfillment No Boolean Default is false, decides if a fulfillment will be passed on to related platform
orders Yes Array An array container for draft shipment orders
+id Yes* Number ID of the order, required if ecommerce_id is empty
+ecommerce_id Yes* String Ecommerce ID of the order, required if id is empty, can not co-exist with id
+tracking_number No String Required if send_fulfillment. Sets the tracking number of order
+carrier No String Required if send_fulfillment. Sets the carrier of order. Available values are [Carriers are only available to registered users, Carriers are only available to registered users]

Request Example

{
    "send_fulfillment": true,
    "orders": [
        {
            "id":   123123123,
            "tracking_number": "1Z123123123123",
            "carrier": "fedex"
        },
        {
            "ecommerce_id":     "AC-1-23453",
            "tracking_number": "1Z1231234234",
            "carrier": "fedex"
        }
    ]
}

Response

Field Type Description
success Boolean true or false
message String Message

Response Examples

Successful

{
    "success": true,
    "data": [],
    "message": "Orders marked as shipped"
}

Failed

{
    "success": false,
    "message": "The given data was invalid.",
    "data": {
        "orders.0.id": [
            "The selected orders.0.id is invalid."
        ],
        "orders.1.id": [
            "The selected orders.1.id is invalid."
        ]
    }
}