/Store/Inventory

Esse recurso gerencia os produtos do estabelecimento. A composição parte de "grupos" de produtos, que posteriormente são expostos publicamente para venda a partir de uma composição de um ou mais itens.

/Product/Groups

Esse recurso gerencia o agrupamento de produtos similares.

Listagem de grupos

GET /v1/merchant/store/inventory/product/groups

Método retorna a listagem de grupos de produtos do estabelecimento.

Query Parameters

Name	Type	Description
page[]	string	Pagination http://jsonapi.org/
filter[]	string	Filter http://jsonapi.org/
sort[]	string	Sort http://jsonapi.org/

200

{
    "items": [
        {
            "id": "268",
            "uid": "2da785f4b936d737adf564e24fbcABCD",
            "externalId": null,
            "merchantId": "534",
            "title": "Borda 1 Sabor",
            "titleProductChoice": "Escolha a Borda",
            "editable": true,
            "priority": "221",
            "active": true,
            "object": "Group"
        }
    ],
    "meta": {
        "page": {
            "total": 99,
            "currentPage": 0,
            "lastPage": 98,
            "perPage": 1
        }
    },
    "links": {
        "last": "/merchant/store/inventory/product/groups?page%5Bnumber%5D=98&page%5Bsize%5D=1",
        "next": "/merchant/store/inventory/product/groups?page%5Bnumber%5D=1&page%5Bsize%5D=1"
    }
}

Request

GET /merchant/store/inventory/product/groups?page[number]=0&page[size]=1&filter[title]=pizza&sort[title]=ASC HTTP/1.1
Authorization: Basic XXXX
Content-Type: application/json

Response | 200: OK

{
    "items": [
        {
            "id": "2999",
            "merchantId": "534",
            "externalId": null,
            "title": "Dia da Pizza",
            "titleProductChoice": "Dia da Pizza",
            "editable": false,
            "priority": "2220",
            "active": true,
            "object": "Group"
        }
    ],
    "meta": {
        "page": {
            "total": 10,
            "currentPage": 0,
            "lastPage": 9,
            "perPage": 1
        }
    },
    "links": {
        "last": "/merchant/store/inventory/product/groups?page%5Bnumber%5D=9&page%5Bsize%5D=1&filter%5Btitle%5D=pizza&sort%5Btitle%5D=ASC",
        "next": "/merchant/store/inventory/product/groups?page%5Bnumber%5D=1&page%5Bsize%5D=1&filter%5Btitle%5D=pizza&sort%5Btitle%5D=ASC"
    }
}

/Products

Esse recurso gerencia os produtos do estabelecimento.

Listagem de produtos

GET /v1/merchant/store/inventory/products

Método retorna a listagem de produtos do estabelecimento. Todo produto é dependente diretamente do grupo do que pertence.

Query Parameters

Name	Type	Description
page[]	string	Pagination http://jsonapi.org/
filter[]	string	Filter http://jsonapi.org/
sort[]	string	Sort http://jsonapi.org/

200

{
    "items": [
        {
            "id": "13637",
            "uid": "2da785f4b936d737adf564e24fbcABCD",
            "externalId": null,
            "merchantId": "534",
            "productGroupId": "2996",
            "productGroupTitle": "Prato do Dia",
            "title": "Pizza G + Pizza P (Grátis)",
            "titleInternalOrder": "Pizza G + Pizza P (Grátis)",
            "image": "",
            "amount": "0.00",
            "amountDiscount": "0.00",
            "amountSale": "0.00",
            "priority": "10654",
            "active": true,
            "object": "Product"
        }
    ],
    "meta": {
        "page": {
            "total": 2,
            "currentPage": 0,
            "lastPage": 1,
            "perPage": 1
        }
    },
    "links": {
        "last": "/merchant/store/inventory/products?page%5Bnumber%5D=1&page%5Bsize%5D=1&filter%5Bproduct_group_id%5D=2996&sort%5Bpriority%5D=ASC"
    }
}

Request

GET 
/api/merchant/store/inventory/products?
page[number]=0&page[size]=1&
filter[product_group_id]=2996&
sort[priority]=ASC HTTP/1.1

Authorization: Basic XXX
Content-Type: application/json

Response | 200: OK

{
    "items": [
        {
            "id": "13637",
            "uid": "2da785f4b936d737adf564e24fbcABCD",
            "externalId": null,
            "merchantId": "534",
            "productGroupId": "2996",
            "productGroupTitle": "Prato do Dia",
            "title": "Pizza G + Pizza P (Grátis)",
            "titleInternalOrder": "Pizza G + Pizza P (Grátis)",
            "image": "",
            "amount": "0.00",
            "amountDiscount": "0.00",
            "amountSale": "0.00",
            "priority": "10654",
            "active": true,
            "object": "Product"
        }
    ],
    "meta": {
        "page": {
            "total": 2,
            "currentPage": 0,
            "lastPage": 1,
            "perPage": 1
        }
    },
    "links": {
        "last": "/merchant/store/inventory/products?page%5Bnumber%5D=1&page%5Bsize%5D=1&filter%5Bproduct_group_id%5D=2996&sort%5Bpriority%5D=ASC"
    }
}

Ativar/inativar produto

PUT /v1/merchant/store/inventory/products/{product_id}

Método atualiza o status do produto, permitindo que o item fique disponível para venda no marketplace.

Path Parameters

Name	Type	Description
product_id	number	Identificador numérico do produto

Request Body

Name	Type	Description
active	boolean	True/False para ativar ou inativar o produto

200

{
    "success": true
}

400

{
    "errors": [
        {
            "status": 400,
            "title": "Grupo de produtos não editável",
            "code": "action_forbidden"
        }
    ]
}

Request

PUT /api/merchant/store/inventory/products/986 HTTP/1.1
Authorization: Basic XXX
Content-Type: application/json
{
    "active": true
}

Response | 200: OK

{
    "success": true
}