Sales
magento-2Orders, invoices, shipments e credit memos.
/rest/V1/orders
Bearer
List orders (searchCriteria)
List orders (searchCriteria).
Admin only.
/rest/V1/orders/:id
Bearer
Get order by ID
Get order by ID.
/rest/V1/orders
Bearer
Create/update an order entity
Create/update an order entity.
Pouco usado — prefira o fluxo de cart/checkout.
/rest/V1/orders/:id/cancel
Bearer
Cancel an order
Cancel an order.
/rest/V1/orders/:id/hold
Bearer
Put an order on hold
Put an order on hold.
/rest/V1/orders/:id/unhold
Bearer
Release order from hold
Release order from hold.
/rest/V1/orders/:id/comments
Bearer
Add comment to an order
Add comment to an order.
/rest/V1/orders/:id/comments
Bearer
List comments
List comments.
/rest/V1/orders/:id/emails
Bearer
Send order email to customer
Send order email to customer.
/rest/V1/orders/:id/statuses
Bearer
Get valid status transitions
Get valid status transitions.
/rest/V1/orders/:id/refund
Bearer
Refund an order (creates credit memo)
Refund an order (creates credit memo).
/rest/V1/orders/items
Bearer
List order items (searchCriteria)
List order items (searchCriteria).
/rest/V1/orders/items/:id
Bearer
Get order item by ID
Get order item by ID.
/rest/V1/invoices
Bearer
List invoices
List invoices.
/rest/V1/invoices/:id
Bearer
Get invoice by ID
Get invoice by ID.
/rest/V1/order/:orderId/invoice
Bearer
Create invoice for an order
Create invoice for an order.
Opções: capture, notify, items (parcial).
/rest/V1/invoices/:id/capture
Bearer
Capture an invoice
Capture an invoice.
/rest/V1/invoices/:id/void
Bearer
Void an invoice
Void an invoice.
/rest/V1/invoices/:id/emails
Bearer
Send invoice email
Send invoice email.
/rest/V1/invoices/comments
Bearer
List invoice comments
List invoice comments.
/rest/V1/invoices/:id/comments
Bearer
Add comment to invoice
Add comment to invoice.
/rest/V1/shipments
Bearer
List shipments
List shipments.
/rest/V1/shipments/:id
Bearer
Get shipment by ID
Get shipment by ID.
/rest/V1/order/:orderId/ship
Bearer
Create shipment for order
Create shipment for order.
Aceita items (parcial) e array de tracks.
/rest/V1/shipment/track
Bearer
Add tracking number to shipment
Add tracking number to shipment.
/rest/V1/shipment/track/:id
Bearer
Remove tracking
Remove tracking.
/rest/V1/shipment/:id/label
Bearer
Generate shipping label
Generate shipping label.
/rest/V1/shipment/:id/label
Bearer
Retrieve shipping label (base64 pdf)
Retrieve shipping label (base64 pdf).
/rest/V1/shipment/:id/emails
Bearer
Send shipment email
Send shipment email.
/rest/V1/shipment/:id/comments
Bearer
Add comment to shipment
Add comment to shipment.
/rest/V1/creditmemos
Bearer
List credit memos
List credit memos.
/rest/V1/creditmemo/:id
Bearer
Get credit memo by ID
Get credit memo by ID.
/rest/V1/creditmemo
Bearer
Create credit memo
Create credit memo.
/rest/V1/creditmemo/refund
Bearer
Refund a credit memo
Refund a credit memo.
/rest/V1/creditmemo/:id/comments
Bearer
Add comment to credit memo
Add comment to credit memo.
/rest/V1/creditmemo/:id/emails
Bearer
Send credit memo email
Send credit memo email.
/rest/V1/transactions
Bearer
List transactions
List transactions.
/rest/V1/transactions/:id
Bearer
Get transaction by ID
Get transaction by ID.