Allows you to mark an order as Payment Received, FFL Received, Order Shipped, Canceled and Force Completed.
Header | Data Type | Valid Values | Required | Description |
---|---|---|---|---|
Content-Type | string | application/json | YES | The format your data will be sent to our site. |
X-DevKey | string | string | YES | The devkey assigned to the developer. |
X-AccessToken | string | string | YES | The token acquired from a POST to Users/AccessToken. |
NOTE: Variables to place in the body of the request.
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
CancelOrder | boolean | true/false |
Optional - Mark order as canceled
NOTE: False will not change this flag. If the order has already been canceled, completed or shipped, this call will not do anything. This flag cannot be combined with other flags in the same request. |
FFLReceived | boolean | true/false |
Optional - Mark order received a FFL
NOTE: False will not change this flag. If this flag was already set to true, this call will not do anything. |
ForceComplete | boolean | true/false |
Optional - Mark order as force complete
NOTE: False will not change this flag. If the order has already been canceled or completed, this call will not do anything. This flag cannot be combined with other flags in the same request. |
OrderShipped | boolean | true/false |
Optional - Mark order has been shipped
NOTE: False will not change this flag. If this flag was already set to true, this call will not do anything. |
PaymentReceived | boolean | true/false | Optional - Mark order has payment received |
If there are no errors with the input parameters, this call will respond with a 200 OK
and a Message Response indicating the item was updated.
Rel | Description | Condition |
---|---|---|
self | The order details |