| POS Screens | Point of Sale Object | APIs |
|---|---|---|
|
Customer | |
|
Cart | SHOP APIs - Basket Resources |
|
Order |
| HTTP Method | Resource | Description |
| POST | /baskets | Create a basket |
| GET | /baskets/{basket_id} | Get a basket |
| PATCH | /baskets/{basket_id} | Updates a basket |
| DELETE | /baskets/{basket_id} | Remove a basket |
| PUT | /baskets/{basket_id}/billing_address | Sets the billing address of a basket |
| POST | /baskets/{basket_id}/coupons | Adds a coupon to an existing basket |
| DELETE | /baskets/{basket_id}/coupons/{coupon_item_id} | Removes a coupon from the basket |
| PUT | /baskets/{basket_id}/customer | Sets customer information for an existing basket |
| POST | /baskets/{basket_id}/gift_certificate_items | Adds a gift certificate item to an existing basket |
| DELETE | /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id} | Deletes a gift certificate item from an existing basket |
| PATCH | /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id} | Updates a gift certificate item of an existing basket |
| POST | /baskets/{basket_id}/items | Adds new items to a basket |
| PATCH | /baskets/{basket_id}/items/{item_id} | Updates an item in a basket |
| DELETE | /baskets/{basket_id}/items/{item_id} | Removes a product item from the basket |
| POST | /baskets/{basket_id}/payment_instruments | Adds a payment instrument to a basket |
| PATCH | /baskets/{basket_id}/payment_instruments/{payment_instrument_id} | Updates a payment instrument of a basket |
| DELETE | /baskets/{basket_id}/payment_instruments/{payment_instrument_id} | Removes a payment instrument from a basket |
| GET | /baskets/{basket_id}/payment_methods | Gets applicable payment methods for an existing basket considering the open payment amount only |
| POST | /baskets/{basket_id}/price_adjustments | Adds a custom manual price adjustment to the basket |
| DELETE | /baskets/{basket_id}/price_adjustments/{price_adjustment_id} | Removes a custom manual price adjustment from the basket |
| PATCH | /baskets/{basket_id}/price_adjustments/{price_adjustment_id} | Updates a custom manual price adjustment on the basket |
| POST | /baskets/{basket_id}/shipments | Creates a new shipment for a basket |
| PATCH | /baskets/{basket_id}/shipments/{shipment_id} | Updates a shipment for a basket |
| DELETE | /baskets/{basket_id}/shipments/{shipment_id} | Removes a specified shipment |
| PUT | /baskets/{basket_id}/shipments/{shipment_id}/shipping_address | Sets a shipping address of a specific shipment of a basket |
| PUT | /baskets/{basket_id}/shipments/{shipment_id}/shipping_method | Sets a shipping method to a specific shipment of a basket |
| GET | /baskets/{basket_id}/shipments/{shipment_id}/shipping_methods | Gets the applicable shipping methods for a certain shipment of a basket |
| HTTP Method | Resource | Description |
| POST | /customer_lists/{customer_list_id}/customer_search | Used for Clientelling in Customer Search |
| HTTP Method | Resource | Description |
| POST | /customers | Registers a customer |
| DELETE | /customers/auth | Invalidates the JWT provided in the header |
| PATCH | /customers/{customer_id} | Updates a customer |
| GET | /customers/{customer_id}/addresses | Returns a sorted pageable list of all customer addresses in the address book. |
| POST | /customers/{customer_id}/addresses | Creates a new address with the given name for the given customer |
| GET | /customers/{customer_id}/addresses/{address_name} | Retrieves a customer's address by address name |
| DELETE | /customers/{customer_id}/addresses/{address_name} | Deletes a customer's address by address name |
| PATCH | /customers/{customer_id}/addresses/{address_name} | Updates a customer's address by address name |
| POST | /customers/{customer_id}/auth | Obtains a new agent on behalf of a registered customer |
| GET | /customers/{customer_id}/baskets | Get the baskets of a customer |
| GET | /customers/{customer_id}/orders | Returns a pageable list of all customer's orders. The default page size is 10 |
| POST | /customers/{customer_id}/password_reset | Starts a password reset process |
| POST | /customers/{customer_id}/product_lists | Creates a customer product list |
| GET | /customers/{customer_id}/product_lists/{list_id} | Returns a customer product list of the given customer |
| GET | /customers/{customer_id}/product_lists/{list_id}/items | Returns a pageable list of all items of a customer's product list. The default page size is 10. |
| POST | /customers/{customer_id}/product_lists/{list_id}/items | Adds an item to the customer's product list |
| GET | /customers/{customer_id}/product_lists/{list_id}/items/{item_id} | Returns an item of a customer product list |
| DELETE | /customers/{customer_id}/product_lists/{list_id}/items/{item_id} | Removes an item from a customer product list |
| HTTP Method | Resource | Description |
| POST | /order_search | Searches for orders |
| HTTP Method | Resource | Description |
| POST | /orders | Submits an order based on a prepared basket |
| GET | /orders/{order_no} | Get information for an order |
| PATCH | /orders/{order_no} | Update an order |
| PATCH | /orders/{order_no}/payment_instruments/{payment_instrument_id} | Updates a payment instrument of an order |