Inventário

Um inventário representa um bem físico, isto é, a quantidade de produtos disponíveis para a venda. Ele contém informações básicas e essenciais, incluindo apenas o SKU, quantidade disponível, unidade de medida e canal de publicação.

Criar uma posição no inventário

Informar a quantidade de produtos disponíveis para a venda em um canal de publicação.

Aviso
  • Para atualizar, basta criar uma nova posição no inventário para que o mesmo seja atualizado.

Escopo requerido

ValorDescrição
portfolio:writePermite gerenciar um inventário

Parâmetros da chamada

PropriedadeTipoDescriçãoObrigatório
skustringO SKU exclusivo do itemSim
quantitydecimalQuantidade do itemSim
unitstringUnidade de médidaSim
extrasobjectInformações adicionais sobre o inventário. Quando não houver um valor você poderá enviar {}.Sim

extras object Informações adicionais sobre o inventário. Quando não houver um valor você poderá enviar . Sim

Chamada:

curl -X 'POST' \
  'https://apps.eupreciso.com.br/v1.0/marketplace/portfolios/inventories' \
  -H 'accept: application / json' \
  -H 'Authorization: Bearer `access_token`' \
  - d '{
    "sku": "XDZ4654",
    "quantity": 2,
    "unit": "unit",
    "extras": {}

Resposta:

{
  "token": "1234",
  "id": "6712a312c37c38e9038fd9b6",
  "statusCode": 0,
  "statusMessage": "The inventory was imported and processed",
  "errors": [],
  "data": {
    "id": "6712a312c37c38e9038fd9b6",
    "sku": "XDZ4654",
    "quantity": 2,
    "unit": "unit",
    "extras": {},
    "created_at": "2022-06-15T14:25:37Z"
  }
}

Recuperar uma posição no inventário

Retorna uma posição do inventário em específico.

Escopo necessário

Valor do escopoDescrição
portfolio:readPermite acessar um SKU.

Parâmetros da URL

CampoTipoDescriçãoObrigatório
idObjectIdIdentificação gerada pelo Eu Preciso quando da criação do Inventário.Sim

Chamada:

GET /v1.0/marketplace/portfolios/inventories/{id} \
Host: apps.eupreciso.com.br \
Authorization: Bearer {access_token} \
Content-Type: application/json \

Resposta:

{
  "id": "6712a312c37c38e9038fd9b6",
  "sku": "XDZ4654",
  "quantity": 2,
  "unit": "unit",
  "extras": {},
  "created_at": "2024-11-15T14:25:37Z"
}

Recuperar uma lista de inventários

Retorna todos os registros de inventário disponíveis.

Nota: Este endpoint implementa paginação, ordenação e filtros. Para saber mais, consulte Paginação, filtros e ordenação.

Escopo requerido

Valor do escopoDescrição
portfolio:readPermite listar os inventários.

Parâmetros de consulta

CampoTipoDescriçãoObrigatório
skustringRetorna os inventários do SKU especificado.Não

Parâmetros de ordenação

CampoDescriçãoObrigatório
created_atOrdenar por data de criação dos SKUs.Não

Chamada:

GET /v1.0/marketplace/portfolios/inventories?_limit=10&_offset=0 \
Host: apps.eupreciso.com.br \
Authorization: Bearer {access_token} \
Content-Type: application/json \

Resposta:

{
  "meta": {
    "page": {
      "limit": 10,
      "offset": 0,
      "count": 10,
      "max_limit": 50
    }
  },
  "results": [
    {
      "id": "6712a312c37c38e9038fd9b6",
      "sku": "XDZ4654",
      "quantity": 2,
      "unit": "unit",
      "extras": {},
      "created_at": "2024-11-15T14:25:37Z"
    }
  ]
}