GunBroker.com REST API
DevKey (optional)     
Enter your DevKey for more detailed help!

/Orders/{orderID}/Flags PUT

Allows you to mark an order as Payment Received, FFL Received, Order Shipped, Canceled, Returned, Refunded and Force Completed.

URL
/Orders/{orderID}/Flags
Verb
Put

Headers

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.

Input

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, returned, 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, returned 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
RefundOrder boolean true/false Optional - Mark order as refunded
NOTE: False will not change this flag. If the order has already been refunded, this call will not do anything. This flag cannot be combined with other flags in the same request.
ReturnOrder boolean true/false Optional - Mark order as returned
NOTE: False will not change this flag. If the order has already been returned or canceled, this call will not do anything. This flag cannot be combined with other flags in the same request.

Output

If there are errors with input parameters, this call will respond with a 400 Bad Request and a Message Response.

If the order is in a status that cannot be updated, this call will respond with a 403 Forbidden and a Message Response.

If there are no errors, this call will respond with a 200 OK and a Message Response indicating the item was updated.

Links

Rel Description Condition
self The order details