Orders¶
Api docs for Orders.
- GET /orders/¶
Get orders for logged in user.
- GET /orders/last/¶
Show last customer order.
- Query Parameters
token – Token to get order when user is not logged in
- GET /orders/all/¶
Show all orders to the admin user, only available if staff user.
- GET /orders/(str: ref)/¶
Get order.
{ "id": 1, "url": "http://localhost:8000/api/orders/2020-00001/", "ref": "2020-00001", "token": "2ObSviY4oVR-2qa-wTsJ6AsYQWuzscb-jCpv80ueclM", "status": "HOLD", "status_display": "Hold", "date_created": "2020-01-10T14:17:24.099278Z", "date_updated": "2020-01-10T14:17:24.103430Z", "is_paid": false, "user": null, "email": "user@example.com", "billing_address": "Test address", "shipping_address": "Test address", "subtotal": "33.00", "extra_rows": [], "total": "33.00", "amount_paid": "0.00", "amount_outstanding": "33.00", "extra": {}, "items": [ { "id": 1, "product_type": "shop.Product", "product_id": 1, "product": { "name": "Product", "code": "1" }, "unit_price": "33.00", "quantity": 1, "subtotal": "33.00", "extra_rows": [], "total": "33.00", "extra": {} } ], "payments": [], "notes": [] }
- Parameters
ref (str) – order ref
- Query Parameters
token – Token to get order when user is not logged in
- GET /orders/(str: ref)/status/¶
Show order status with transitions, only available if staff user.
{ "status": "HOLD", "status_display": "Hold", "status_transitions": [ { "value": "NEW", "label": "New", "error": "Can't change order with status 'Hold' to 'New'." }, { "value": "CREATED", "label": "Created", "error": "Can't change order with status 'Hold' to 'Created'." }, { "value": "HOLD", "label": "Hold", "error": null }, { "value": "FAILED", "label": "Failed", "error": null }, { "value": "CANCELLED", "label": "Cancelled", "error": null }, { "value": "PROCESSING", "label": "Processing", "error": null }, { "value": "SHIPPED", "label": "Shipped", "error": "Can't change order with status 'Hold' to 'Shipped'." }, { "value": "COMPLETED", "label": "Completed", "error": "Can't change order with status 'Hold' to 'Completed'." }, { "value": "REFUNDED", "label": "Refunded", "error": "Can't change order with status 'Hold' to 'Refunded'." } ] }
- Parameters
ref (str) – order ref
- PUT /orders/(str: ref)/status/¶
Change order status, only available if staff user.
{ "status": "PROCESSING", "status_display": "Processing" }
- Parameters
ref (str) – order ref
- JSON Parameters
status (str) – new order status
- Status Codes
400 Bad Request – if supplied params are invalid
- GET /orders/(str: ref)/pay/¶
List payment methods with
salesman.checkout.payment.PaymentMethod.order_payment()
implemented. Show error message if it exist.{ "payment_methods": [ { "identifier": "credit-card", "label": "Credit Card", "error": null } ] }
- Parameters
ref (str) – order ref
- Query Parameters
token – Token to get order when user is not logged in
- POST /orders/(str: ref)/pay/¶
Pay for order. Get redirect URL to either the next payment step or the order success page. Depending on the used payment method redirect to this URL.
{ "url": "https://credit-card-payment.com/?order=2020-00001&total=33.00" }
- Parameters
ref (str) – order ref
- Query Parameters
token – Token to get order when user is not logged in
- Status Codes
400 Bad Request – if supplied params are invalid
402 Payment Required – if payment error appears
- POST /orders/(str: ref)/refund/¶
Refund all order payments, only available if staff user.
{ "refunded": [ { "amount": "33.00", "transaction_id": "43ae45fa-6af8-4dcf-a854-b1f8245ec07b", "payment_method": "credit-card", "date_created": "2020-01-10T14:49:25.105242Z" } ], "failed": [] }
- Parameters
ref (str) – order ref
- Status Codes
206 Partial Content – if some payments failed while refunding