Change Shipping Address

PATCH

https://restapi.ordergroove.com/orders/:order_id/change_shipping/

PATCH

/orders/:order_id/change_shipping/

curl -X PATCH https://restapi.ordergroove.com/orders/order_id/change_shipping/ \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "customer": "00026001",
  "payment": "070001bc02fd11e99542bc764e1043b0",
  "shipping_address": "66c25cd0564011e9abc5bc764e107990",
  "public_id": "c4e05d04ccc411e8ada3bc764e101db1",
  "sub_total": "22.90",
  "tax_total": "0.00",
  "shipping_total": "5.99",
  "discount_total": "21.08",
  "total": "28.89",
  "created": "2018-10-10 14:43:32",
  "place": "2019-06-06 12:08:37",
  "cancelled": "2019-04-05 12:13:32",
  "tries": 1,
  "generic_error_count": 0,
  "status": 1,
  "type": 1,
  "order_merchant_id": "",
  "rejected_message": "",
  "extra_data": "",
  "locked": false,
  "oos_free_shipping": false
}

Changes the shipping address associated with an order.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Path parameters

order_idstringRequired

Unique order ID

Request

This endpoint expects an object.

shipping_addressstringOptional

Shipping Address ID

Response

200

merchantstringOptional

customerstringOptional

paymentstringOptional

shipping_addressstringOptional

public_idstringOptional

sub_totalstringOptional

tax_totalstringOptional

shipping_totalstringOptional

discount_totalstringOptional

totalstringOptional

createdstringOptional

placestringOptional

cancelledstringOptional

triesintegerOptionalDefaults to 0

generic_error_countintegerOptionalDefaults to 0

statusintegerOptionalDefaults to 0

typeintegerOptionalDefaults to 0

order_merchant_idstringOptional

rejected_messagestringOptional

extra_datastringOptional

lockedbooleanOptionalDefaults to true

oos_free_shippingbooleanOptionalDefaults to true

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error