batches

Endpoint to submit order batches (HTTP verbs: POST).

APIDescription
POST api/v1/batches

Submit a batch of orders.

POST api/sandbox/batches

Submit a batch of orders in a Sandbox Environment. Batches are still validated but only processed upon request.
Orders submitted to the Sandbox are not returned by GET api/v1/orders unless they have been processed.

rmas

Endpoint to submit ReturnTrak type RMA or to retrieve RMA(s) status (HTTP verbs: GET and POST).

APIDescription
GET api/v1/rmas

Return full status of ReturnTrak type RMAs (filtered by parameters).

POST api/v1/rmas

Submit a ReturnTrak type RMA.

rmas (v2)

Endpoint to submit ReturnTrak type RMA or to retrieve RMA(s) status (HTTP verbs: GET and POST). This API implements the eFactory 10 features.

APIDescription
GET api/v2/rmas

Return full status of ReturnTrak type RMAs (filtered by parameters).

POST api/v2/rmas

Submit a ReturnTrak type RMA.

orders

Endpoint to retrieve order status or to cancel an order (HTTP verbs: GET and PUT).

APIDescription
GET api/v1/orders

Return full status of orders (filtered by parameters).

PUT api/v1/orders/cancel

Cancel an order.

items

Endpoint to retrieve item status (HTTP verbs: GET).

APIDescription
GET api/v1/items

Return a list of all items (filtered by parameters).

GET api/v1/items/returns

Return a list of items returned (filtered by parameters).

documents

Endpoint to get documents (Proofs Of Delivery, Commercial Invoices, Packing Lists) (HTTP verbs: GET).

APIDescription
GET api/v1/documents

Returns the documents requested in base64 format.

po_receipts

Endpoint to retrieve PO receipts (HTTP verbs: GET).

APIDescription
GET api/v1/po_receipts

Return a list of PO receipts (filtered by parameters).

po_notifications

Endpoint to submit/update PO notifications (HTTP verbs: POST and PUT).

APIDescription
POST api/v1/po_notifications

Submit a purchase order notification.

PUT api/v1/po_notifications

Update the expected delivery date of a PO notification not yet received.