Update Order
PATCH/orders/:order_number
Update an existing order
Request
Responses
- 200
- 400
- 404
- 409
- 422
OK
Response Headers
X-Request-Id
Unique ID generated to track each HTTP request sent
Example:
f4c93531-bf4f-438e-b2ce-1dcff5e7ad97X-Honeybee-Signature
Base64 encoded HMAC-SHA1 hash of method, url and body
Example:
Jzk2+9Pi6UIH/0PvGaq8CKZccwMKETag
Entity Tag used to verify cached response object
Example:
W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"Malformed Request
Response Headers
X-Request-Id
Unique ID generated to track each HTTP request sent
Example:
f4c93531-bf4f-438e-b2ce-1dcff5e7ad97Not Found
Conflicting Request
Response Headers
X-Request-Id
Unique ID generated to track each HTTP request sent
Example:
f4c93531-bf4f-438e-b2ce-1dcff5e7ad97#Invalid Request
Error Codes
| Status Code | Meaning | Description |
|---|---|---|
| 42221 | Invalid Address First Name | The provided first name was invalid. |
| 42222 | Invalid Address Last Name | The provided last name was invalid. |
| 42223 | Invalid Address Street1 | The provided street1 was invalid. |
| 42225 | Invalid Address City | The provided city was invalid. |
| 42226 | Invalid Address State Abbreviation | The state provided did not match a correct 2-character state code. |
| 42227 | Invalid Address Zip | The zip code provided was formatted incorrectly, or did not exist in the state provided. |
| 42228 | Invalid Address Update | The shipping address cannot be updated, order has already shipped. |
| 42229 | Invalid Address Controlled Substance | The shipping address cannot be updated, order contains controlled substances. |
| 42230 | Invalid Address | The provided address was invalid. |
| 42231 | Invalid Address State | The state provided cannot be shipped to. |
| 42241 | Invalid Item NDC | The provided NDC does not match a product offering in the catalog. |
| 42242 | Invalid Item Quantity | The provided quantity does not match a product offering in the catalog. |
| 42246 | Invalid Item GCN | The provided GCN Sequence Number does not match a product offering in the catalog. |
| 42247 | Invalid Item Package Size | The provided package size does not match a product offering in the catalog. |
| 42248 | Invalid Item Action | The provided action does not match the enumerable values acceptable. |
| 42249 | Invalid Item Prescription Id | The provided prescription Id was invalid |
| 42250 | Invalid Item Prescription Refills | The provided prescription has no refills remaining |
| 42251 | Invalid Item Not Found | The attempt to update an order item was not found, please check ndc or gcn_seqno supplied |
| 42252 | Invalid Item Update Ndc | The attempt to update an order item NDC was invalid. Please check update_ndc supplied |
| 42253 | Invalid Item Inventory | The requested order item has no available inventory remaining |
| 42254 | Invalid Item SKU | The requested SKU does not match a product offering in the catalog. |
| 42255 | Invalid Item Prescription Quantity | The requested quantity exceeds what is on the prescription. |
| 42256 | Invalid Item Shipping Method | The requested shipping method cannot be used on an item in this order. |
| 42257 | Invalid Item Prescription Expired | The requested prescription is expired. |
| 42291 | Invalid Shipping Method Id | The provided shipping method id is invalid. |
| 42292 | Invalid Shipping Signature Confirmation | The requested shipping signature confirmation is not available for the shipping method id selected. |
| 42293 | Invalid Shipping Method Carrier | The requested shipping method is incompatible with addresss for general delivery or PO BOX. |
| 42294 | Invalid Shipping Label Format | The provided shipping label format is invalid. |
| 42295 | Invalid Shipping Label Impermissible | The account is not permitted to submit custom shipping labels. |
| 42296 | Invalid Shipping Label Data | The label data provided does not match the format. |
| 42380 | Invalid Brand | The provided brand id did not match a known brand for this account. |
Response Headers
X-Request-Id
Unique ID generated to track each HTTP request sent
Example:
f4c93531-bf4f-438e-b2ce-1dcff5e7ad97X-Honeybee-Signature
Base64 encoded HMAC-SHA1 hash of method, url and body
Example:
Jzk2+9Pi6UIH/0PvGaq8CKZccwMK