Update Order (Coming Soon)

This API endpoint allows you to update an existing order in the system.

Endpoint

PUT: https://wms.eshopbox.com/api/v1/shipping/order/edit

Headers

Header Name	Type	Description
Authentication	string	Bearer Token to authenticate the request.

Request Body Parameters

The following table outlines the parameters that can be included in the request body. Parameters marked as mandatory must be provided.

Name	Type	Description	Mandatory
vendorOrderNumber	string	Unique order number assigned by the vendor	Yes
billingAddress.contactphone	string	Phone number associated with the billing address	Yes
externalChannelID	string	Unique ID for the sales channel	No
externalWarehouseID	string	Warehouse ID where the order will be fulfilled	No
paymentType	string	Payment type: "prepaid" or "cod"	No
isCOD	string	"1" for COD, "0" for prepaid	No
items	array of objects	Product items in the order	No
removedItems	array of objects	Items removed in the edit	No
addedItems	array of objects	Items added in the edit	No
shippingAddress	object	Full shipping address	No
billingAddress	object	Billing address details (contactphone is mandatory)	Partially Yes
customerOrderNumber	string	Customer-facing order number	No
actor	string	Email ID of the user performing the edit	No
shipChargeAmount	number	Shipping charges	No

Example cURL Request

curl --location --request PUT 'https://wms.eshopbox.com/api/v1/shipping/order/edit' \
--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \
--data-raw '{
    "orderType": "import",
    "externalChannelID": "CH8445",
    "externalWarehouseID": "Qastaging_CCTesting",
    "sameAddress": false,
    "paymentType": "prepaid",
    "isCOD": "0",
    "suggestedTrackingNumber": "",
    "invoiceNumber": "",
    "suggestedCourierLabel": "",
    "isSecureShipment": true,
    "items": [
        {
            "productImageUrl": "https://storage.googleapis.com/eshopbox_uploads_staging/product_create/Crop_Top_250402063637437-3851.jpg",
            "quantity": 3,
            "giftMessage": "Happy Birthday.",
            "discount": 0,
            "lineItemTotal": "2850",
            "isVirtualKit": "0",
            "customerPrice": 950,
            "productName": "Slim Fit Jogger",
            "itemID": "John@#",
            "lineItemSequenceNumber": 0,
            "isGift": "1",
            "taxAmount": 0,
            "taxCode": "ESBGST1",
            "sku": "HNXP83H674Q",
            "skuset": "HNXP83H674Q",
            "externalWarehouseID": "Qastaging_CCTesting",
            "unitPrice": 950,
            "sellerTotal": "2850",
            "sellerSkuOnChannel": "HNXP83H674Q",
            "isproduct": true,
            "productAdditionalInfo": {
                "productDetails": {
                    "hsnCode": "65457",
                    "dimensionHeight": 10,
                    "dimensionLength": 20,
                    "accountSlug": "qastaging",
                    "weight": 180,
                    "mrp": 999,
                    "dimensionWidth": 20,
                    "type": "BASE",
                    "sku": "John@#",
                    "esin": "HNXP83H674Q",
                    "status": "ACTIVE",
                    "weightUnit": "g"
                }
            },
            "giftWrapCharges": 0
        }
    ],
    "removedItems": [],
    "addedItems": [],
    "shippingAddress": {
        "city": "New Delhi",
        "countryCode": "",
        "postalCode": "110001",
        "addressLine1": "64 Sector 18 Hsidc Maruti Indl Area",
        "addressLine2": "",
        "countryName": "IN",
        "state": "Delhi",
        "contactPhone": "9999999999",
        "customerName": "John",
        "email": "[e-mail]",
        "gstin": ""
    },
    "billingAddress": {
        "city": "Delhi",
        "countryCode": "",
        "postalCode": "110001",
        "addressLine1": "64 Sector 18 Hsidc Maruti Indl Area",
        "addressLine2": "",
        "countryName": "IN",
        "state": "Delhi",
        "contactPhone": "9999999999",
        "customerName": "John doe",
        "email": "[e-mail]",
        "gstin": ""
    },
    "customerOrderNumber": "50_Custom_New_5-cp124",
    "vendorOrderNumber": "50_Custom_New_5-cp124",
    "autOrderID": false,
    "bkpCustomerOrderID": "",
    "giftMsg": "Happy Birthday.",
    "isGift": "1",
    "invoiceDate": "2025-04-28T09:49:57.619Z",
    "otherCharge": 0,
    "balanceDue": 0,
    "orderTotal": 3724,
    "subtotal": 3649,
    "actor": "[e-mail]",
    "shipMethod": "STD",
    "accountSlug": "qastaging",
    "thirdPartySh

Success Response

{
  "status": "success",
  "message": "Order updated successfully",
  "orderId": "ORD123456"
}

---

Error Responses

400 Bad Request This indicates that one or more required fields were not provided or are invalid.

401 Unauthorized This indicates an authentication failure. The Bearer token may be expired or missing.

404 Not Found The order you are trying to update does not exist in the system.