dev: https://commerce-uat.enervee.com
\nproduction: https://commerce.enervee.com
\nAuthentication is via an API token. Enervee will supply separate tokens for dev and prod.
\nA request to the API requires an Authentication header
\nThe header should have the key \"Authorization\" and value \"Token token-given-by-Enervee\"
Here's an example request to the order status endpoint, in CURL syntax:
\ncurl -X GET -H \"Authorization: Token <token>\" \"https://commerce-uat.enervee.com/api/fulfillment/orders/\"\n\nOr with a fake token:
\ncurl -X GET -H \"Authorization: Token 989393939393939a65\" \"https://commerce-uat.enervee.com/api/fulfillment/orders/158288-001\"\n\nThis documentation uses some conventions in notation:
\nNRV1234: identifiers starting with NRV denote Enervee order numbers.
FFL1234: identifiers starting with FFL denote Fulfillment Partner order numbers.
SRL1234: identifiers starting with SRL denote product serial numbers.
UPS1234, FEDEX1234: shipment tracking identifiers start with a carrier’s short name.
sku: is the fulfillment partner SKU ID, ie not the Enervee SKU ID.
Order cancellation is currently a manual process.
\nWhen the user requests order cancelation with Enervee, Enervee customer support will email the Fulfillment Partner’s customer support with a cancelation request for the order, including the order’s external order number for reference. Once Enervee receives confirmation of the cancelation from the Fulfillment Partner, Enervee will cancel the order internally.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"45386809","collectionId":"0ae499af-be85-408c-bef6-86f5fd1deb0f","publishedId":"2sB2qdgzop","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"017AFF"},"publishDate":"2025-05-28T21:03:21.000Z"},"item":[{"name":"Retrieve Orders","id":"15105083-40ce-4474-8d38-baf0050d823c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token ","type":"text"}],"url":"https://commerce-uat.enervee.com/api/fulfillment/orders?after=2025-05-27T00:00&before=2025-05-28T00:00&partner_code=appliance-retailer-01","description":"As orders enter a fulfillable state, they will become available at the orders endpoint.
We suggest polling for new orders in the last hour, or however long you want to wait in between polling for orders. Most of our partners pull orders hourly.
\nGET /api/fulfillment/orders
partner_code (required, str):
Your partner code as assigned by Enervee. One API access token may be associated with multiple fulfillment partner IDs. For example, if one fulfillment partner has multiple platforms which may interact with Enervee, each platform may receive its own partner_code.
specific date range:
\nafter (required, datetime format YYYY-MM-DDThh:mm[:ss[.uuuuuu]]):
Return orders updated after this time.
before (optional, datetime format YYYY-MM-DDThh:mm[:ss[.uuuuuu]], default now):
Return orders updated before this time.
last x hours:
after (required, -xh hours format -#h, ex: -5h): Return orders updated within the last x hoursThe maximum time span that can be requested is 7 days.
\nIf after or partner_code parameters are omitted, we return HTTP 400
If after and before specify a time period longer than 7 days, we return HTTP 400
If after is a time after before, we return HTTP 400
If partner_code is incorrect for the user, we return HTTP 400
This request acknowledges an order.
\nNote that there are two options for acknowledging received orders back to Enervee, each with pros and cons. A single order can be acknowledged at a time (this request), returning clear success and failure responses for each attempt, at the cost of performance with having to make multiple HTTP calls for multiple orders. Alternatively, multiple orders can be acknowledged with a single call (see the Acknowledge Multiple Orders request below), but any issues with any of the orders will prevent all submitted orders from being processed.
PUT /api/fulfillment/orders/{order_number}/acknowledge
If the order requested is not found, we return HTTP 404 with the order_number that was not found
If the order requested already has an external order number assigned, we return HTTP 400 containing the current external order number
This endpoint acknowledges multiple orders with a single call.
\nNote that any issues with any of the orders will prevent all submitted orders from being processed.
\nPOST /api/fulfillment/orders/acknowledge
If any order listed is not found, we return HTTP 404 with each order_number that was not found
If any order listed already has an external order number assigned, we return HTTP 400 with each order_number that has already been acknowledged, along with its current external order number
The above two scenarios may be combined if both situations occur simultaneously
\nTo facilitate development and debugging, we provide an order details endpoint that will provide the comprehensive state of an order. This endpoint will not be used in the normal flow of processing an order, but may be useful for gleaning insights into the process or for debugging errors.
\nGET /api/fulfillment/orders/{order_number}
external_order_number may be an empty string if the fulfillment partner has not acknowledged the order yet.
status may be any of fulfillment_pending, shipped, settled, settled_cancel, settled_partial_return, settled_return, or error.
products[].status may be any of fulfillment_pending, fulfillment_in_progress, shipped, delivered, return_fulfillment_pending, return_fulfillment_failed, returned, cancel_pending_fulfillment_partner, or canceled.
products[].serial_numbers is optional and dependent on the fulfillment partner providing such information to us. When present, the number of serial numbers will match the accompanying products[].quantity.
HTTP 404 with the order_number that was not foundPOST /api/fulfillment/orders/{order_number}/shipments
Shipping details must be provided per-product. If multiple products are shipped together, shipping details for the single shipment must be provided separately for each product in the shipment.
\nIf a shipped product has a serial number, it should be provided alongside shipping details.
\nserial_numbers is optional. If present, the number of serial numbers provided must match the quantity of products being notified as “shipped”.
If the order requested is not found, we return HTTP 404 with the order_number that was not found
If the external_order_number provided does not match the external_order_number on the specified order, we return HTTP 400 with error details specifying the order_number and the invalid external_order_number
If the specified order has not been acknowledged, we return HTTP 400
If specified product(s) (by sku) are not associated with the given order, we return HTTP 404
If given product(s) specifies serial_numbers in number not matching quantity, we return HTTP 400
If specified product(s) (by sku) contain duplicates in serial_numbers, we return HTTP 400 with the serial_numbers that are duplicated
If specified product(s) (by sku) have a specified quantity greater the the quantity available to be shipped (regardless of serial_numbers presence), we return HTTP 400
POST /api/fulfillment/orders/{order_number}/returns
serial_numbers is optional, but MUST be included if the returned products were notified to us as “shipped” with a serial number.
If provided, the number of serial numbers must match the quantity of products being notified as “returned”.
\nIf the order requested is not found, we return HTTP 404 with the order_number that was not found
If the external_order_number provided does not match the external_order_number on the specified order, we return HTTP 400:
If the specified order has not been acknowledged, we return HTTP 400
If specified product(s) (by sku) are not associated with the given order, we return HTTP 404
If given product(s) specifies serial_numbers in number not matching quantity, we return HTTP 400
If specified product(s) (by sku) contain duplicates in serial_numbers, we return HTTP 400 with the serial_numbers that are duplicated
If specified product(s) (by sku) contain no serial_numbers field, but were shipped with serial numbers, we return HTTP 400 with the products requiring serial numbers for return
If specified product(s) (by sku) specify any serial_numbers that are not found in their shipping history, we return HTTP 400 with the specified serial_numbers that have not been shipped yet
If specified product(s) (by sku) are already fully marked as returned, we return HTTP 400 with the products that have no returnable quantity
If specified product(s) (by sku) have a specified quantity greater than the quantity available to be returned (regardless of serial_numbers presence), we return HTTP 400
This request updates the inventory count of a single product SKU.
\nPUT /api/fulfillment/incentory/{sku}/update
HTTP 404 with the sku that was not found