The GitHub repository for the project can be found here. It provides information on how to get the proejct \"Up and Running\".
\nThe instructions found in this documentation will allow you to successfully work with all the endpoints that this API provides.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Documentation for the E-Commerce API Project","slug":"documentation-for-the-e-commerce-api-project"}],"owner":"26698816","collectionId":"f34decce-3831-43ca-82e5-74b6780e94b3","publishedId":"2s946fdsnQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-07-16T01:46:58.000Z"},"item":[{"name":"JWT Token","item":[{"name":"Get Tokens","id":"e3186ea3-0457-4a9c-9082-1b39793d7d91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"jane_doe","type":"text"},{"key":"password","value":"jane#passwd","type":"text"}]},"url":"http://localhost:8000/api/token/","description":"access and refresh tokensThe request's payload requires the username and password of a registered account
Valid refresh token
\n","type":"text"}]},"url":"http://localhost:8000/api/token/refresh/","description":"access tokenThe request's payload requires an active refresh token
Refresh token to be blacklisted
\n","type":"text"}]},"url":"http://localhost:8000/api/token/blacklist/","description":"refresh tokenThe operation blacklists the passed refresh token which prevents the generation of new access tokens. Additionally, the operation also blacklists the current active access token associated to the refresh token.
The request's payload requires the refresh token to be blacklisted.
\n","urlObject":{"protocol":"http","port":"8000","path":["api","token","blacklist",""],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"790d81d9-3240-4bd4-9064-d8b2ab708ded","name":"Blacklist Refresh Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"refresh","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY4OTU1ODU1MiwiaWF0IjoxNjg5NDcyMTUyLCJqdGkiOiJjYTkwYmM4YzJkOTk0YTM3YmYzMDI5NTNiN2VkZTQyNSIsInVzZXJfaWQiOjY2fQ.D8rE0m33zroPwyzbVyaMe0TIJP7q6hhZ2TZYERxrSFs","description":"Refresh token to be blacklisted","type":"text"}]},"url":"http://localhost:8000/api/token/blacklist/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 16 Jul 2023 01:55:43 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.11.3"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"2"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"5e0d7573-4f9d-4c58-8d00-d95693186d9d"}],"id":"3411eb1c-cc6c-49ac-92d9-a1ab0e113dd5","description":"After you have created an account, use the Get Tokens endpoint to generate your access and refresh tokens.
Description: It's used to perform authenticated requests.
\nDuration: 5 minutes.
\nDescription: It's used to generate new access tokens.
\nDuration: 24 hours.
\n","_postman_id":"3411eb1c-cc6c-49ac-92d9-a1ab0e113dd5"},{"name":"Accounts","item":[{"name":"Customers List","id":"591e942b-f8c1-4f80-95b4-dd3bf5c07bfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://localhost:8000/api/customers","description":"The operation retrieves the list of all active customers
\nOn the customer's account creation, a shopping cart (cart) is automatically assigned to the customer.
\n","urlObject":{"protocol":"http","port":"8000","path":["api","customers"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"92fbed87-9851-4ce1-ade7-e50aa90f35a5","name":"Customer Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"john_doe","type":"text"},{"key":"email","value":"john_dow@e-commerce-api.com","type":"text"},{"key":"first_name","value":"John","type":"text"},{"key":"last_name","value":"Doe","type":"text"},{"key":"birthdate","value":"1998-12-01","type":"text"},{"key":"about","value":"John Doe's optional bio","type":"text"},{"key":"password","value":"john#passwd","type":"text"},{"key":"avatar_url","value":"http://localhost:8000/media/images/john_doe.png","type":"text"}]},"url":"http://localhost:8000/api/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 16 Jul 2023 02:15:19 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.11.3"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"324"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"email\": \"john_dow@e-commerce-api.com\",\n \"username\": \"john_doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"about\": \"John Doe's optional bio\",\n \"avatar_url\": \"http://localhost:8000/media/images/john_doe.png\",\n \"birthdate\": \"1998-12-01\",\n \"is_active\": true,\n \"is_staff\": false,\n \"last_login\": null,\n \"date_joined\": \"2023-07-16T02:15:19.656708Z\"\n}"}],"_postman_id":"99499924-1f75-46dc-b6d7-5ee192e3c935"},{"name":"Customer Details","id":"9c24d059-a94f-48a1-9828-81e7203cff6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:8000/api/customers/1","description":"If a matching customer is found, this operation will fetch its data.
\nThe endpoint's URL has the form of /api/customers/{customerID}
New value to be set (updated)
\n","type":"text"}]},"url":"http://localhost:8000/api/customers/1","description":"This operation updates the data of the customer's account with the data provided in the payload (if it is valid)
\nThe endpoint's URL has the form of /api/customers/{customerID}
Deleting an account could break multiple relationships, therefore, this operation sets the account as inactive.
\nCustomers with inactive accounts will not be able to get refresh and access tokens and therefore, will not be able to interact with the API.
The endpoint's URL has the form of /api/customers/{customerID}
The operation retrieves the list of all active admins
\nAdmin accounts haveis_staff=True attribute
No shopping cart is assigned to admin accounts
\n","urlObject":{"protocol":"http","port":"8000","path":["api","admins"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"4490f67c-b0ae-4903-bdc2-9cf5d4ed7a7d","name":"Admin Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"richard_roe","type":"text"},{"key":"email","value":"richard_roe@e-commerce-api.com","type":"text"},{"key":"first_name","value":"Richard","type":"text"},{"key":"last_name","value":"Roe","type":"text"},{"key":"birthdate","value":"1998-12-01","type":"text"},{"key":"about","value":"Richard Roe's optional bio","type":"text"},{"key":"password","value":"richard#passwd","type":"text"},{"key":"avatar_url","value":"http://localhost:8000/media/images/richard_roe.png","type":"text"}]},"url":"http://localhost:8000/api/admins"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 16 Jul 2023 21:43:39 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.11.3"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"338"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 6,\n \"email\": \"richard_roe@e-commerce-api.com\",\n \"username\": \"richard_roe\",\n \"first_name\": \"Richard\",\n \"last_name\": \"Roe\",\n \"about\": \"Richard Roe's optional bio\",\n \"avatar_url\": \"http://localhost:8000/media/images/richard_roe.png\",\n \"birthdate\": \"1998-12-01\",\n \"is_active\": true,\n \"is_staff\": true,\n \"last_login\": null,\n \"date_joined\": \"2023-07-16T21:43:39.177712Z\"\n}"}],"_postman_id":"b8f85cfd-d85e-41a3-92b1-9377b45f2cb5"},{"name":"Admin Details","id":"417ea74e-c11f-48fd-9084-b584f1871ec2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"If the matching admin is found, this operation will fetch its data.
\nThe endpoint's URL has the form of /api/admins/{adminID}
New value to be set
\n","type":"text"},{"key":"","value":"","type":"text","disabled":true}]},"url":"http://localhost:8000/api/admins/6","description":"This operation updates the data of the admin's account with the data provided in the payload (if it is valid)
\nThe endpoint's URL has the form of /api/admins/{adminID}
Deleting an account could break multiple relationships, therefore, this operation sets the account as inactive.
\nAdmins with inactive accounts will not be able to get refresh and access tokens and therefore, will not be able to interact with the API.
The endpoint's URL has the form of /api/admins/{adminID}
There are a total of three roles (accounts type)
\nThe hierarchy in terms of the level of authorization is defined as follows
\nEach account type has a set of permissions and constraints defined across all the endpoints of the project. More information and clarification on the subject will be found in the sections further down below.
\n","_postman_id":"e60f69cb-c49a-4374-b736-499bb6d1d84b"},{"name":"Images","item":[{"name":"Add Image","id":"dbe2fe92-adff-4aff-9f85-c6702e3c10cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","src":"/home/adolfoj/Pictures/e-commerce/watches/1_220804_m_halskette_decimal_marmor_antiksilber_cv_1_q.jpg"}]},"url":"http://localhost:8000/api/images","description":"Images endpoints are used to load images files to the server and then use its returning image URL in other's request payload, e.g,
\nThe idea behind this implementation is to simplify sending requests that may require an image and also, allow frontend implementation that can, for example, load an image (user avatar) while the user fills in the registration form, resulting in more efficient requests.
\nFor the image URL attributes (such as the ones mentioned above) any URL can be used, as long as it matches the attribute's format criteria (text max length 512 chars).
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The endpoint's URL has the form of /api/categories/{categoryID}
New value to be set
\n","type":"text"}]},"url":"http://localhost:8000/api/categories/1","description":"The endpoint's URL has the form of /api/categories/{categoryID}
The endpoint's URL has the form of /api/categories/{CategoryID}/products
This section provides information on how to work with the endpoints in order to create, retrieve, and update categories, and also on how to retrieve the list of products associated with a category.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a2f3a44c-b519-4f00-b336-c9787cb8853f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"66854cb8-eedf-43d7-a3a9-de96542d6bb5","type":"text/javascript","exec":[""]}}],"_postman_id":"5abbf26f-845b-4e1f-8f95-dfd672916870"},{"name":"Products","item":[{"name":"Product List","id":"36dd3151-d2f9-4898-959a-eefec95364bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://localhost:8000/api/products","description":"If the data provided in the payload is valid, a product will be created.
\nThe new product will then be added to the inventory associating it with an inventory item.
\nLevel of authorization required
\nThe following attributes cannot be updated as they are serialized as read-only.
\nIn the example below, the attribute available is set to true with the PATCH request, but in the response, the attribute reads as false. Given that the quantity attribute is 0 the product is still unavailable.
In order to serialize available=true, the product serializer will verify that:
DeletedProducts tableDeletedProducts table.Deleting a product breaks multiple relationships, which could break any front-end app built with the API. This endpoint added the matching product to the DeletedProducts, which maintains the API integrity.
It is important to note that unavailable products are unreachable by customers as they are filtered out automatically.
\navailable attribute set to TrueDeleteProduct tableThe endpoint's URL has the structure /api/inventory-items/{inventory-itemID}
The endpoint's URL has the structure /api/inventory-items/{inventory-itemID}
On creation, each product gets an inventory item with a quantity attribute.
\nThe inventory item instance associated with a product is used to register the quantity of the product in stock (a.k.a inventory).
\nThe Inventory's endpoints are internal-use only, therefore, only admins and superusers are allowed to perform operations over them.
\nId of the product to be added to the cart
\n"},{"key":"quantity","value":"1","type":"text","description":"Units of the product to be added to the cart
\n"}]},"url":"http://localhost:8000/api/cart/items","description":"The endpoint's URL has the structure api/cart/items/{itemID}
The endpoint's URL has the structure api/cart/items/{itemID}
The endpoint's URL has the structure api/cart/items/{itemID}
/api/cart: Retrives the cart's details for the customer making the request/api/cart/items: Retrieves the items in the customers' cart/api/cart/items/{itemID}: Retrieves cart item detailsThe endpoint's URL has the structure /api/carts/{cartID}
The endpoint's URL has the structure /api/cart-items/{cart-itemID}
This section provides information on how to work with the endpoints for carts, which also includes cart items.
\nThe structure of a cart is defined as follows:
\nTo simplify the process of working with cart and cart items, this API offers endpoints for customers and admin/superusers.
\nYou will find sub-sections down below for:
\nThis request will create an order which will be automatically associated with the requesting customer. The available cart items in the customer's cart will be used to create order items for the order.
\nThe endpoint's URL has the structure /api/orders/{orderID}`
/api/order-items/{order-itemID}The structure of orders and order items is very similar to the structure of carts and cart items.
\nOrders only process cart items whose products are available. If a product was added to a cart (with a cart item) and then it became unavailable (e.g., it ran out), the order will not process such a cart item, therefore, it will be left in the cart.
\nCustomers can only retrieve their own orders and order-items
\n/api/reviews/{reviewID}
/api/reviews/{reviewID}
/api/reviews/{reviewID}
A review instance consists of
\n