Skip to content

Change shipping method

POST /v1/change_ship_method

Changes the shipping carrier and method of an existing order. Only applies to orders that haven't shipped yet.

Request

Send username, password and secretkey along with a data object. See Making requests.

{
  "username": "YOUR_USERNAME",
  "password": "YOUR_PASSWORD",
  "secretkey": "YOUR_SECRET_KEY",
  "data": {
    "xid": "23542123",
    "order_id": "1001",
    "carrier": "FEDEX",
    "service": "FEDEX_GROUND",
    "packaging": "YOUR_PACKAGING",
    "notes": "notes"
  }
}

curl -X POST https://gatewaybeta.marcofinearts.com/v1/change_ship_method \
  -H "Content-Type: application/json" \
  -d '{
    "username": "YOUR_USERNAME",
    "password": "YOUR_PASSWORD",
    "secretkey": "YOUR_SECRET_KEY",
    "data": {
      "xid": "23542123",
      "order_id": "1001",
      "carrier": "FEDEX",
      "service": "FEDEX_GROUND",
      "packaging": "YOUR_PACKAGING",
      "notes": "notes"
    }
  }'

data fields

Field Required Validation Notes
xid Conditional Your order number. Required if order_id is not passed.
order_id Conditional Marco Fine Arts order ID. Required if xid is not passed.
carrier Yes Valid carrier
service Yes Valid method code for the carrier
packaging No
notes No Extra shipping notes.

Response

{
  "res": "success"
}

{
  "res": "error",
  "code": "000",
  "message": "Error message."
}

Error codes

Code Error Description
701 Authentication failed Your account is invalid or does not have API access. Check username, password and secretkey.
702 Missing field One or more required fields are missing.
711 Invalid data Invalid shipping carrier.
712 Invalid data Invalid shipping method.
714 Missing field order_id or xid is required.
715 Invalid data Invalid order_id or xid.
720 Error Order has already shipped; shipping details can't be changed.