Catalogo

(GET) /buybox/{marketplaceId}

    API Endpoint

        https://api.omnik.io/v1/catalog/buybox/{marketplaceId}
            

                
# Here is a curl example
curl --location \
'https://api.omnik.io/v1/catalog/buybox/{marketplaceId}' \
--header 'token: {token}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

[
  {
    "ranking": 0,
    "sku": "string",
    "skuIntegrationId": "string",
    "sellerTenant": "string",
    "sellerName": "string",
    "sellerLogoUrl": "string",
    "fromPrice": 0,
    "price": 0,
    "inventory": 0,
    "productWeight": 0,
    "deliveryOptions": [
      {
        "deliveryTime": 0,
        "deliveryTimeType": "bd",
        "deliveryEstimateBusinessDays": 0,
        "providerShippingCost": 0,
        "description": "string",
        "deliveryMethodName": "string",
        "logisticProviderName": "string"
      }
    ]
  }
]
                
            

Consulta de Buybox pelo ID do Marketplace

Path Parameters

Campo	Tipo	Descrição
marketplaceId	string	(required) ID do Marketplace

Query Parameters

Campo	Tipo	Descrição
destinationZipcode	number	(optional) Cep de entrega, utilizado para cálculo do frete

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso

(POST) /buybox

    API Endpoint

        https://api.omnik.io/v1/catalog/
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/v1/catalog/' \
--header 'token: {token}' \
--header 'Content-Type: application/json'
--data '[
  {
    "marketplaceId": "string",
    "sku": "string",
    "skuIntegrationId": "string",
    "sellerTenant": "string",
    "fromPrice": 0,
    "price": 0,
    "inventory": 0,
    "productWeight": 0
  }
]'
                
            

                
Result example 2xx:

{
  "validItems": [
    {
      "marketplaceId": "string",
      "sku": "string",
      "skuIntegrationId": "string",
      "sellerTenant": "string",
      "messages": [
        "string"
      ]
    }
  ],
  "invalidItems": [
    {
      "marketplaceId": "string",
      "sku": "string",
      "skuIntegrationId": "string",
      "sellerTenant": "string",
      "messages": [
        "string"
      ]
    }
  ]
}
                
            

Incluir um novo Buybox

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso

(GET) /products/skus/ paginado

    API Endpoint

        https://api.omnik.io/v1/catalog/products/skus/
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/v1/catalog/products/skus/' \
--header 'token: {token}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "pageSize": 0,
  "pageIndex": 0,
  "pages": 0,
  "totalOnPage": 0,
  "total": 0,
  "items": [
    {
      "id": "string",
      "tenant": "string",
      "operator": "string",
      "createDate": "string",
      "lastUpdate": "string",
      "productId": "string",
      "skuId": "string",
      "sku": "string",
      "seller": {
        "id": "string",
        "name": "string",
        "document": "string"
      },
      "category": {
        "channel": "string",
        "id": "string",
        "name": "string",
        "fullName": "string",
        "id1": "string",
        "name1": "string",
        "id2": "string",
        "name2": "string",
        "id3": "string",
        "name3": "string",
        "id4": "string",
        "name4": "string",
        "id5": "string",
        "name5": "string",
        "id6": "string",
        "name6": "string",
        "id7": "string",
        "name7": "string",
        "id8": "string",
        "name8": "string"
      },
      "name": "string",
      "productName": "string",
      "brand": "string",
      "description": "string",
      "gtin": "string",
      "stock": 0,
      "attributes": [
        {
          "id": "string",
          "name": "string",
          "value": "string",
          "descriptionValue": "string",
          "required": true
        }
      ],
      "images": [
        {
          "thumbnail": "string",
          "small": "string",
          "average": "string",
          "big": "string",
          "link": "string",
          "main": true,
          "number": 0,
          "url": "string",
          "validated": true
        }
      ],
      "productStatus": "in-progress",
      "skuStatus": "in-progress",
      "matchStatus": "pending",
      "matchSuggestions": [
        {
          "name": "string",
          "sku": "string",
          "gtin": "string",
          "marketplaceId": "string",
          "marketplaceProductId": "string",
          "similarity": 0,
          "images": [
            {
              "thumbnail": "string",
              "small": "string",
              "average": "string",
              "big": "string",
              "link": "string",
              "main": true,
              "number": 0,
              "url": "string",
              "validated": true
            }
          ],
          "attributes": [
            {
              "id": "string",
              "name": "string",
              "value": "string",
              "descriptionValue": "string",
              "required": true
            }
          ],
          "categories": [
            {
              "channel": "string",
              "id": "string",
              "name": "string",
              "fullName": "string",
              "id1": "string",
              "name1": "string",
              "id2": "string",
              "name2": "string",
              "id3": "string",
              "name3": "string",
              "id4": "string",
              "name4": "string",
              "id5": "string",
              "name5": "string",
              "id6": "string",
              "name6": "string",
              "id7": "string",
              "name7": "string",
              "id8": "string",
              "name8": "string"
            }
          ]
        }
      ],
      "active": true,
      "matchId": "string",
      "productMatchId": "string",
      "marketplaceId": "string",
      "errors": [
        {
          "code": "string",
          "type": "string",
          "message": "string"
        }
      ],
      "priceData": {
        "fromPrice": 0,
        "price": 0,
        "costPrice": 0
      },
      "productSellerPlatformId": "string",
      "productSellerPlatform": "string"
    }
  ]
}
                
            

Consulta de Skus do Catalogo paginada

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso

Query Parameters

Campo	Tipo	Descrição
status	string	(optional) status do Pedido
pageIndex	integer	(optional) indica a partir de onde ocorre um aumento
pageSize	integer	(optional) indica a quantidade de recursos a serem devolvidos, variando de 10 a no máximo 50
orderBy	string	(optional) indica por qual atributo a consulta deve ser classificada (lastUpdate ou createDate) (Default lastUpdate)
fields	array[string]	(optional) Campos que serão apresentados na consulta
productStatus	string	(optional) Status do Produto (in-progress, curation-ok, curation-not-ok, waiting-match, waiting-category, waiting-moderation, waiting-publish, published, not-published, error, republish-failed)
matchStatus	string	(optional) Status do Match (pending, match, no-match, rejected)
moderationStatus	string	(optional) Status da Moderação (approved, not-approved, pending)
productId	string	(optional) ID do Produto
categoryId	string	(optional) ID da Categoria
sku	string	(optional) Código do SKU
dateType	string	(optional) Tipo de Data que será usada no filtro: Data de Criação ou Data da última atualização
startDate	string	(optional) Data Inicial
endDate	string	(optional) Data Final
sellerTenant	string	(optional) Tenant do Seller
productName	string	(optional) Nome do Produto
skuName	string	(optional) Nome do SKU
skuActive	boolean	(optional)
minStock	number	(optional) Estoque mínimo
maxStock	number	(optional) Estoque máximo

(GET) /moderated/{productId}

    API Endpoint

        https://api.omnik.io/HUB/v1/products/moderated/{productId}
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/products/moderated/{productId}' \
--header 'token: {token}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "account": "string",
  "productData": {
    "active": true,
    "id": "string",
    "productName": "string",
    "description": "string",
    "descriptionHTML": "string",
    "brand": "string",
    "tags": "string",
    "warranty": 0,
    "variant": true,
    "unit": "string",
    "unitInitials": "string",
    "origin": "string"
  },
  "codes": [
    {
      "code": "string"
    }
  ],
  "categories": [
    {
      "channel": "string",
      "id": "string",
      "name": "string",
      "fullName": "string",
      "id1": "string",
      "name1": "string",
      "id2": "string",
      "name2": "string",
      "id3": "string",
      "name3": "string",
      "id4": "string",
      "name4": "string",
      "id5": "string",
      "name5": "string",
      "id6": "string",
      "name6": "string",
      "id7": "string",
      "name7": "string",
      "id8": "string",
      "name8": "string"
    }
  ],
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "descriptionValue": "string",
      "required": true
    }
  ],
  "skus": [
    {
      "operator": "string",
      "tenant": "string",
      "active": true,
      "skuData": {
        "id": "string",
        "tenant": "string",
        "sku": "string",
        "skuName": "string",
        "gtin": "string",
        "model": "string",
        "crossdockingDays": 0,
        "supplierCode": "string",
        "erpCode": "string",
        "establishmentCode": "string",
        "moderationDate": "string",
        "active": true,
        "productType": "string",
        "productCondition": "string",
        "skuOriginal": "string",
        "platformId": "string"
      },
      "codes": [
        {
          "code": "string"
        }
      ],
      "errors": [
        {
          "code": "string",
          "type": "string",
          "message": "string"
        }
      ],
      "priceData": {
        "fromPrice": 0,
        "price": 0,
        "costPrice": 0
      },
      "packageDimensionData": {
        "width": 0,
        "height": 0,
        "depth": 0,
        "grossWeight": 0
      },
      "images": [
        {
          "thumbnail": "string",
          "small": "string",
          "average": "string",
          "big": "string",
          "link": "string",
          "main": true,
          "number": 0,
          "url": "string",
          "validated": true
        }
      ],
      "attributes": [
        {
          "id": "string",
          "name": "string",
          "value": "string",
          "descriptionValue": "string",
          "required": true
        }
      ],
      "marketplaces": [
        {
          "marketplace": "string",
          "marketPlaceId": "string",
          "marketplaceId": "string",
          "marketPlaceProductId": "string"
        }
      ],
      "matches": [
        {
          "marketplace": "string",
          "marketPlaceId": "string",
          "marketplaceId": "string",
          "marketPlaceProductId": "string"
        }
      ],
      "matchStatus": "pending"
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "marketplaceId": "string",
      "marketPlaceProductId": "string"
    }
  ],
  "platformData": {
    "acronym": "string",
    "platformId": "string",
    "platform": "string",
    "lastUpdate": "string",
    "commissionValue": 0,
    "active": true,
    "json": "string"
  }
}
                
            

Consulta a Moderação do Produto

Path Parameters

Campo	Tipo	Descrição
productId	string	(required) ID do Produto

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso

(PUT) /products/publishResult

    API Endpoint

        https://api.omnik.io/v1/catalog/products/publishResult
            

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/v1/catalog/products/publishResult' \
--header 'token: {token}' \
--data '[
  {
    "productId": "string",
    "marketplaceId": "string",
    "result": "published",
    "message": "string",
    "skus": [
      {
        "message": "string",
        "marketplaceId": "string",
        "skuId": "string"
      }
    ]
  }
]'
                
            

                
Result example 2xx:

No content
                
            

Confirmação da publicação do Item

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso

(POST) /categorize

    API Endpoint

        https://api.omnik.io/HUB/v1/products/categorize
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/products/categorize' \
--header 'token: {token}' \
--header 'Content-Type: application/json' \
--data '{
  "category": {
    "id": "string",
    "tag": "string",
    "mainId": "string",
    "mainName": "string",
    "marketplace": "string",
    "channel": "string",
    "id1": "string",
    "name1": "string",
    "fullName": "string",
    "name": "string"
  },
  "sellerId": "string",
  "productId": "string"
}'
                
            

                
Result example 2xx:

no content
                
            

Categorizar Produto

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso

(GET) /skuseller/{sku}

    API Endpoint

        https://api.omnik.io/HUB/v1/products/skus/skuseller/{sku}
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/products/skus/skuseller/{sku}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "active": true,
  "skuData": {
    "id": "string",
    "tenant": "string",
    "sku": "string",
    "skuName": "string",
    "gtin": "string",
    "model": "string",
    "crossdockingDays": 0,
    "supplierCode": "string",
    "erpCode": "string",
    "establishmentCode": "string",
    "moderationStatus": "string",
    "moderationDate": "string",
    "productType": "string",
    "productCondition": "string",
    "description": "string",
    "descriptionHTML": "string"
  },
  "productData": {
    "id": "string"
  },
  "codes": [
    {
      "code": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "type": "string",
      "message": "string"
    }
  ],
  "priceData": {
    "fromPrice": 0,
    "price": 0,
    "costPrice": 0
  },
  "stockData": {
    "stock": 0,
    "minStock": 0
  },
  "packageDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "images": [
    {
      "thumbnail": "string",
      "small": "string",
      "average": "string",
      "big": "string",
      "link": "string",
      "main": true,
      "number": 0
    }
  ],
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de SKU pelo Código de sku do Seller

Path Parameters

Campo	Tipo	Descrição
sku	string	(required) Código de SKU

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(optional) Tenant ID do Seller (se Operador)

Query Parameters

Campo	Tipo	Descrição
inventory	string	(optional) Incluir Estoque atualizado? Default: false

(GET) /inventory

    API Endpoint

        https://api.omnik.io/HUB/v1/products/skus/skuseller/{sku}/inventory
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/products/skus/skuseller/{sku}/inventory' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "productId": "string",
  "tenant": "string",
  "sku": "string",
  "inventory": 0,
  "entries": 0,
  "out": 0,
  "reserves": 0,
  "type": "string",
  "local": "string"
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Estoque do SKU pelo Código de sku do Seller

Path Parameters

Campo	Tipo	Descrição
sku	string	(required) Código de SKU

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(optional) Tenant ID do Seller (se Operador)

(GET) /price

    API Endpoint

        https://api.omnik.io/HUB/v1/products/skus/skuseller/{sku}/price
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/products/skus/skuseller/{sku}/price' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "productId": "string",
  "tenant": "string",
  "sku": "string",
  "fromPrice": 0,
  "price": 0,
  "costPrice": 0,
  "campaigns": {
    "id": "string",
    "discount": 0
  }
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Preço do SKU pelo Código de sku do Seller

Path Parameters

Campo	Tipo	Descrição
sku	string	(required) Código de SKU

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(optional) Tenant ID do Seller (se Operador)

(GET) /crossdockingdays

    API Endpoint

        https://api.omnik.io/HUB/v1/products/skus/skuseller/{sku}/crossdockingdays
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/products/skus/skuseller/{sku}/crossdockingdays' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "productId": "string",
  "tenant": "string",
  "sku": "string",
  "fromPrice": 0,
  "price": 0,
  "costPrice": 0,
  "campaigns": {
    "id": "string",
    "discount": 0
  }
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Prazo do SKU pelo Código de sku do Seller

Path Parameters

Campo	Tipo	Descrição
sku	string	(required) Código de SKU

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(optional) Tenant ID do Seller (se Operador)