POST/v1/orders/update-shipping

Update Shipping

Updating the shipping details may not always be possible depending on the order status. You should check the responses below carefully and manage successful/unsuccessful responses in your system. An orders shipping address can not be updated once the order has been shipped.

Making a Request

Include the headers and order data in your request.

POST

/v1/orders/update-shipping

curl -X POST https://api.mpodx.com/v1/orders/update-shipping \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{  //... your order data  }'

The Update Shipping Model

Properties

Name
Type
string
Description
The MPODx order reference (required).
Name
Type
string
Description
The shipping name (required).
Name
Type
string
Description
The shipping phone (optional).
Name
Type
string
Description
The shipping address line 1 (required).
Name
Type
string
Description
The shipping address line 2 (optional).
Name
Type
string
Description
The shipping city (required).
Name
Type
string
Description
The shipping ZIP code (required).
Name
Type
string
Description
The shipping state (required).
Name
Type
string
Description
The shipping country (required).

Data Structure

Example data structure

{
  "order_ref": "PKG12345",
  "shipping_name": "John Doe",
  "shipping_phone": "+1234567890",
  "shipping_address_1": "123 Main St",
  "shipping_address_2": "Apt 4B",
  "shipping_city": "New York",
  "shipping_zip": "10001",
  "shipping_state": "NY",
  "shipping_country": "USA"
}

Update Shipping

Used when you need to update the shipping address for an order

This information shows you how to update the shipping address for an order. Review the responses carefully and handle them in your system.

The data below shows the required fields for this API call.

Required Fields

{
  "order_ref": "PKG12345",
  "shipping_name": "John Doe",
  "shipping_address_1": "123 Main St",
  "shipping_city": "New York",
  "shipping_zip": "10001",
  "shipping_state": "NY",
  "shipping_country": "USA"
}

200 - Successful Response

{
  "message":"Address updated successfully",
  "status":"success",
  "data": {
    "order_ref": "PKG12345",
    "shipping_name": "John Doe",
    "shipping_phone": "+1234567890",
    "shipping_address_1": "123 Main St",
    "shipping_city": "New York",
    "shipping_zip": "10001",
    "shipping_state": "NY",
    "shipping_country": "USA"
  }
}

200 - Error Response

  {
    "message":"Address not updated",
    "status":"error",
    "data":{
      "order_ref": "PKG12345"
    }
  }