/Orders/{orderID}/Update PUT

Update the Shipping, Payment, and FFL information for an Order. OutdoorPay / OmniPay orders cannot ForceComplate, nor can they Mark Payment Received non Layaway orders.

URL
/Orders/{orderID}/Update
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
FFLNumber string string The FFL License Number to associate to the order. If an FFL License number is provided, the Ship To information will be ignored and the FFL Premise Address and contact information will be used.

License number should be passed in this format: #-##-XXX-XX-XX-#####, where each # is a required digit

Optional (No change made to this value if excluded)

Valid FFL # Set? ShipTo Address Set? Outcome
NO NO No change to FFL # or address
YES NO FFL # saved. ShipTo Address set to FFL Premise Address
NO YES No change to FFL #. ShipTo Address set to the provided address
YES YES FFL # saved. ShipTo Address set to the provided address
PaymentMethod int 4 - Check
8 - Visa/Mastercard
16 - COD
32 - Escrow
64 - Amex
128 - Discover
512 - PayPal
8192 - Certified Check
16384 - USPS Money Order
32768 - Money Order
65536 - FreedomCoin
Payment Method

Optional (No change made to this value if excluded)
ShipClass int 1 - Overnight
2 - 2-Day
4 - 3-Day
8 - Ground
16 - USPS First Class
32 - USPS Priority Mail
64 - Other
128 - In Store Pick Up
256 - Alaska, Hawaii & Terr., Non-Continental US, Other
Shipping Class

Optional (No change made to this value if excluded)
ShipToName string string Ship to Contact Name.

Conditional (Required when any other ShipTo conditional field is set)
ShipToAddress1 string string Ship to Address line 1

Conditional (Required when any other ShipTo conditional field is set)
ShipToAddress2 string string Ship to Address line 2

Optional
ShipToCity string string Ship to City

Conditional (Required when any other ShipTo conditional field is set)
ShipToState string string Ship to 2 digit State code.

Conditional (Required when any other ShipTo conditional field is set)
ShipToPostalCode string string Ship to Postal code.

Conditional (Required when any other ShipTo conditional field is set)
ShipToCountryCode string string Ship to 2 digit Country code.

Conditional (Required when any other ShipTo conditional field is set)
ShipToPhone string string Ship to Phone number.

Conditional (Required when any other ShipTo conditional field is set)
ShipToEmail string string Ship to Email address.

Optional

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