Product was successfully added to cart Product was successfully added to wishlist Your bid has been placed
{{PopupAddToCartVueModal.ProductName}}
There are {{PopupAddToCartVueModal.TotalItems}} in your cart. There are {{PopupAddToCartVueModal.TotalItems}} in your wishlist. You have {{PopupAddToCartVueModal.TotalItems}} ongoing auctions
Extended Web Api
Operations with Orders
How to get all orders
GET /odata/order
Request Type: GET
Enter the request URL: http://StoreURL/odata/order
Auth type: Bearer Token - paste the token generated in the previous steps
How to get all orders from specified dates
GET /odata/order?$filter
Request Type: GET
Enter the request URL: http://StoreURL/odata/order?$filter=CreatedOnUtc gt 2021-01-20T03:30:00.000Z and CreatedOnUtc lt 2021-01-23T03:30:00.000Z
Auth type: Bearer Token - paste the token generated in the previous steps
As a result, you will receive orders from 20.01.2021 to 23.01.2021.
How to get all imported orders
GET /odata/order?$filter
Request Type: GET
Enter the request URL: http://StoreURL/odata/order?$filter=Imported eq true
Auth type: Bearer Token - paste the token generated in the previous steps
As a result, you will receive orders from 20.01.2021 to 23.01.2021.
How to get order by id
GET /odata/order('id')
Request Type: GET
Enter the request URL: http://StoreURL/odata/order('id')
Auth type: Bearer Token - paste the token generated in the previous steps
As a result you will get only category with specified ID.
How to delete order
POST /odata/order('id')/DeleteOrder
Request Type: POST
Enter the request URL: http://StoreURL/odata/Order('id')/DeleteOrder
Auth type: Bearer Token - paste the token generated in the previous steps
How to cancel order
POST /odata/order('id')/CancelOrder
Request Type: POST
Enter the request URL: http://StoreURL/odata/Order('id')/CancelOrder
Auth type: Bearer Token - paste the token generated in the previous steps
As a result, the specified order will be canceled.
How to mark order as paid
POST /odata/order('id')/MarkAsPaid
Request Type: POST
Enter the request URL: http://StoreURL/odata/Order('id')/MarkAsPaid
Auth type: Bearer Token - paste the token generated in the previous steps
As a result, the payment status will be changed to Paid
How to mark order as Imported
POST /odata/order('id')/SetAsImported
Request Type: POST
Enter the request URL: http://StoreURL/odata/Order('id')/SetAsImported
Auth type: Bearer Token - paste the token generated in the previous steps
As a result, the specified order will be marked as Imported.
How to mark order as Authorized
POST /odata/order('id')/MarkAsAuthorized
Request Type: POST
Enter the request URL: http://StoreURL/odata/Order('id')/MarkAsAuthorized
Auth type: Bearer Token - paste the token generated in the previous steps
As a result, the specified order will be marked as Authorized.
Operations with Shipments
How to get all shipments
GET /odata/shipment
Request Type: GET
Enter the request URL: http://StoreURL/odata/order
Auth type: Bearer Token - paste the token generated in the previous steps
How to create shipment
POST /odata/shipment/(ID)/Create
Request Type: POST
Enter the request URL: http://StoreURL/odata/Shipment/(id)/Create
Auth type: Bearer Token - paste the token generated in the previous steps
Body:
How to get shipment by ID
GET /odata/shipment('id')
Request Type: GET
Enter the request URL: http://StoreURL/odata/Shipment('id')
Auth type: Bearer Token - paste the token generated in the previous steps
How to set tracking number
POST /odata/shipment('id')/SetTrackingNumber
Request Type: POST
Enter the request URL: http://StoreURL/odata/Shipment('id')/SetTrackingNumber
Auth type: Bearer Token - paste the token generated in the previous steps
Body:
{
"TrackingNumber": "string"
}
How to delete shipment
POST /odata/shipment('id')/DeleteShipment
Request Type: POST
Enter the request URL: http://StoreURL/odata/Shipment('id')/DeleteShipment
Auth type: Bearer Token - paste the token generated in the previous steps
How to set as shipped
POST /odata/shipment('id')/SetAsShipped
Request Type: POST
Enter the request URL: http://StoreURL/odata/Shipment('id')/SetAsShipped
Auth type: Bearer Token - paste the token generated in the previous steps
As a result, the specified order will be marked as shipped.
How to mark shipment as delivered
POST /odata/shipment('id')/SetAsDelivered
Request Type: POST
Enter the request URL: http://StoreURL/odata/Shipment('id')/SetAsDelivered
Auth type: Bearer Token - paste the token generated in the previous steps
As a result, the shipment will be marked as delivered
Operations with Return Requests
How to get all return requests
GET /odata/returnrequest
Request Type: GET
Enter the request URL: http://StoreURL/odata/returnrequest
Auth type: Bearer Token - paste the token generated in the previous steps
How to update return request
GET /odata/returnrequest('ID')
Request Type: GET
Enter the request URL: http://StoreURL/odata/returnrequest('id')
Auth type: Bearer Token - paste the token generated in the previous steps
How to update return request
POST /odata/returnrequest/(id)/Update
Request Type: POST
Enter the request URL: http://StoreURL/odata/returnrequest/(id)/Update
Auth type: Bearer Token - paste the token generated in the previous steps
{
"externalId": null,
"staffNotes": "string",
"notifyCustomer": true,
"returnRequestStatus": 0
}
How to delete return request
POST /odata/returnrequest/(id)/Delete
Request Type: POST
Enter the request URL: http://StoreURL/odata/returnrequest/(id)/Delete
Auth type: Bearer Token - paste the token generated in the previous steps