Authentication

Public and private key based authentication

In the onboarding process, we will create an account for the partner in our ecosystem and from there we will provide the public and private key.These keys will need to be in the header of all the requests in this document.

Available endpoints

List Doris categories

Method: GET
Endpoint: https://api.doris.services/v1/orchestrator/category/doris-category-list
Description: This endpoint lists Doris' categories, so that when you import products you can associate your product with the category that represents the item in our ecosystem..

Request example:

1curl -X GET "https://api.doris.services/v1/orchestrator/category/doris-category-list" \
2-H "doris_api_key: YOUR PUBLIC API KEY" \
3-H "doris_secret_key: YOUR SECRET API KEY"

Response example:

1{
2    "category": [
3        {
4            "id": 2,
5            "name": "tshirt",
6            "type": "TOP"
7        },
8        {
9            "id": 5,
10            "name": "shorts",
11            "type": "BOTTOM"
12        }
13    ]
14    // ...
15}

Importing products

Import a product

Method: POST
Endpoint: https://api.doris.services/v1/orchestrator/pub/product
Description: This endpoint allows only one product to be created at a time. If you want to create more than one product at a time, skip to session Import products in batch.

Body:

1{
2  "name": "the product name",
3  "description": "the product description",
4  "image_urls": "[https://example.com/cool-tshirt-image-123.jpg, https://example.com/cool-tshirt-image-345.jpg]",
5  "identifier": "101010",
6  "parent_identifier": "101010",
7  "sku_id": "998877",
8  "url": "https://example.com/cool-tshirt",
9  "regular_price": 329.8,
10  "special_price": 309.8,
11  "doris_category_id": 2,
12  "doris_category_name": "tshirt",
13  "doris_category_type": "TOP",
14  "size_label": "P",
15  "has_stock": true,
16  "installment": 3,
17  "installment_value": 109.93,
18  "gender": "MALE",
19  "tuck_in_default": "TUCK_IN",
20  "brand": "product brand name"
21}

Request example:

1curl -X POST "https://api.doris.services/v1/orchestrator/pub/product" \
2-H "doris_api_key: YOUR PUBLIC API KEY" \
3-H "doris_secret_key: YOUR SECRET API KEY" \
4-d "{
5  "name": "the product name",
6  "description": "the product description",
7  "image_urls": "[https://example.com/cool-tshirt-image-123.jpg, https://example.com/cool-tshirt-image-345.jpg]",
8  "identifier": "101010",
9  "parent_identifier": "101010",
10  "sku_id": "998877",
11  "url": "https://example.com/cool-tshirt",
12  "regular_price": 329.8,
13  "special_price": 309.8,
14  "doris_category_id": 2,
15  "doris_category_name": "tshirt",
16  "doris_category_type": "TOP",
17  "size_label": "P",
18  "has_stock": true,
19  "installment": 3,
20  "installment_value": 109.93,
21  "gender": "MALE",
22  "tuck_in_default": "TUCK_IN",
23  "brand": "product brand name"
24}"

The above request will only create the P size of the product in question. To create multiple products with multiple sizes, we recommend using the Import products in batch

Import products in batch

Method: POST
Endpoint: https://api.doris.services/v1/orchestrator/pub/product-by-bulk
Description: This endpoint allows you to create several products at the same time.

Body: A list of products, with the same specifications as the Import a product endpoint

Request example:

1curl -X POST "https://api.doris.services/v1/orchestrator/pub/product-by-bulk" \
2-H "doris_api_key: YOUR PUBLIC API KEY" \
3-H "doris_secret_key: YOUR SECRET API KEY" \
4-d "[
5  {
6    "name": "the product name",
7    "description": "the product description",
8    "image_urls": "[https://example.com/cool-tshirt-image-123.jpg, https://example.com/cool-tshirt-image-345.jpg]",
9    "identifier": "101010",
10    "parent_identifier": "101010",
11    "sku_id": "998877", // unique sku code for size P
12    "url": "https://example.com/cool-tshirt",
13    "regular_price": 329.8,
14    "special_price": 309.8,
15    "doris_category_id": 2,
16    "doris_category_name": "tshirt",
17    "doris_category_type": "TOP",
18    "size_label": "P",
19    "has_stock": true,
20    "installment": 3,
21    "installment_value": 109.93,
22    "gender": "MALE",
23    "tuck_in_default": "TUCK_IN",
24    "brand": "your brand name"
25  },
26  {
27    "name": "the product name",
28    "description": "the product description",
29    "image_urls": "[https://example.com/cool-tshirt-image-123.jpg, https://example.com/cool-tshirt-image-345.jpg]",
30    "identifier": "101010",
31    "parent_identifier": "101010",
32    "sku_id": "998878", // unique sku code for size M
33    "url": "https://example.com/cool-tshirt",
34    "regular_price": 329.8,
35    "special_price": 309.8,
36    "doris_category_id": 2,
37    "doris_category_name": "tshirt",
38    "doris_category_type": "TOP",
39    "size_label": "M",
40    "has_stock": true,
41    "installment": 3,
42    "installment_value": 109.93,
43    "gender": "MALE",
44    "tuck_in_default": "TUCK_IN",
45    "brand": "your brand name"
46  },
47  {
48    "name": "the product name",
49    "description": "the product description",
50    "image_urls": "[https://example.com/cool-tshirt-image-123.jpg, https://example.com/cool-tshirt-image-345.jpg]",
51    "identifier": "101010",
52    "parent_identifier": "101010",
53    "sku_id": "998879", unique sku code for size G
54    "url": "https://example.com/cool-tshirt",
55    "regular_price": 329.8,
56    "special_price": 309.8,
57    "doris_category_id": 2,
58    "doris_category_name": "tshirt",
59    "doris_category_type": "TOP",
60    "size_label": "G",
61    "has_stock": false,
62    "installment": 3,
63    "installment_value": 109.93,
64    "gender": "MALE",
65    "tuck_in_default": "TUCK_IN",
66    "brand": "your brand name"
67  },
68]"

Update a product

Method: PUT
Endpoint: https://api.doris.services/v1/orchestrator/pub/product/{identifier}
Description: This endpoint allows you to enable or disable a product, change its name, url and gender. Activates or deactivates a product, change the name, change the url or change the gender.

Parameters:

identifier: the product identifier

Body:

1{ 
2  "name": "the new product name", // optional
3  "url": "https://example.com/new-cool-tshirt", // optional
4  "active": false, // optional
5  "gender": "FEMALE", // optional
6}

Request example:

1curl -X PUT "https://api.doris.services/v1/orchestrator/pub/product/101010" \
2-H "doris_api_key: YOUR PUBLIC API KEY" \
3-H "doris_secret_key: YOUR SECRET API KEY" \
4-d "{ 
5  "name": "the new product name", 
6  "url": "https://example.com/new-cool-tshirt",
7  "active": false,
8  "gender": "FEMALE",
9}"

Updating price and stock

Method: PUT
Endpoint: https://api.doris.services/v1/pub/product-price-stock
Description: This endpoint is used to keep the price and stock of the product updated in our ecosystem.

It's important to say that we don't care how many products you have in stock, only whether you have them or not.

Body:

1{ 
2  "sku_id": "998879", 
3  "has_stock": false,
4  "regular_price": 100,
5  "special_price": 90
6}

Request example:

1curl -X PUT "https://api.doris.services/v1/orchestrator/pub/product-price-stock" \
2-H "doris_api_key: YOUR PUBLIC API KEY" \
3-H "doris_secret_key: YOUR SECRET API KEY" \
4-d "{ 
5  "sku_id": "998879", 
6  "has_stock": false,
7  "regular_price": 100,
8  "special_price": 90
9}"

On this page

Introduction Authentication Update a product Updating price and stock

Hello, experience-commece