Pick lists

Listar

GET /api/v1/pick_lists

Filtros

Os parâmetros abaixo podem ser passados como uma query string. Datas devem ser passadas no formato ISO 8601.

Este serviço suporta paginação.

• status: indica qual o status deseja consultar, podendo ser um desses valores:

  • draft: Em Edição

  • waiting_confirmation: Aguardando Confirmação

  • confirmed: Pendente

  • waiting_cancellation: Aguardando Cancelamento

  • cancelled: Cancelada.

• separate_status: indica qual o status da separação que deseja consultar, podendo ser um desses valores:

  • pending: Pendente

  • in_separation: Em separação

  • separated: Separação concluída

• pending_only: pode ser true ou false. Se for true, apenas as pick lists pendentes serão listadas. (campo deprecado, favor usar o campo status)

  • Caso não seja passado, é considerado false.

• updated_since: filtra pick lists atualizadas a partir da data informada.

• updated_until: filtra pick lists atualizadas até a data informada.

Retorno

É retornado um JSON contendo um array com objetos que correspondem às pick lists. Os campos de cada pick list são os seguintes:

• id: o id da pick list

• created_at: a data de criação da pick list, no formato ISO 8601.

• updated_at: a data de atualização da pick list, no formato ISO 8601.

• installation_id: o id da instalação da pick list

• planogram_id: o id do planograma da pick list

• group_id: o id do grupo da pick list

• distribution_center_id: o id do centro de distribuição

• supply_category_id: o id da categoria de abastecimento

• separate_status: é o status da separação

• machine_id: o id da máquina

• pending: true se pick list estiver pendente, false se não estiver (campo deprecado, favor usar o campo status)

• status: indica qual o status atual da pick list

• url: o endereço da pick list no VMpay

• notes: observações sobre a pick list

• rotas: rotas vinculadas a instalação da pick list

Segue um exemplo de retorno de consulta:

[
  {
    "id": 2692,
    "created_at": "2015-08-28T14:45:50.000-03:00",
    "updated_at": "2015-08-31T16:44:18.000-03:00",
    "installation_id": 363,
    "planogram_id": 1046,
    "group_id": 1,
    "distribution_center_id": 1,
    "supply_category_id": 1,
    "separate_status": "separated",
    "machine_id": 235,
    "pending": false,
    "status": "applied",
    "url": "https://vmpay.vertitecnologia.com.br/api/v1/machines/235/installations/363/pick_lists/2692",
    "notes": "some extra info",
    "routes": [
      {
        "id": 1,
        "name": "Route 01"
      },
      {
        "id": 2,
        "name": "Other route"
      }
    ]
  },
  {
    "id": 5248,
    "created_at": "2015-12-16T16:33:23.000-02:00",
    "updated_at": "2015-12-17T17:25:24.000-02:00",
    "installation_id": 1170,
    "planogram_id": 3172,
    "group_id": 1,
    "distribution_center_id": 1,
    "supply_category_id": 1,
    "separate_status": "in_separation",
    "machine_id": 643,
    "pending": false,
    "status": "applied",
    "url": "https://vmpay.vertitecnologia.com.br/api/v1/machines/643/installations/1170/pick_lists/5248",
    "notes": null,
    "routes": [
      {
        "id": 1,
        "name": "Route 01"
      },
      {
        "id": 2,
        "name": "Other route"
      }
    ]
  },
  {
    "id": 5560,
    "created_at": "2015-12-29T16:12:20.000-02:00",
    "updated_at": "2016-01-05T15:28:02.000-02:00",
    "installation_id": 1170,
    "planogram_id": 3172,
    "group_id": 1,
    "distribution_center_id": 1,
    "supply_category_id": 1,
    "separate_status": "pending",
    "machine_id": 643,
    "pending": false,
    "status": "cancelled",
    "url": "https://vmpay.vertitecnologia.com.br/api/v1/machines/643/installations/1170/pick_lists/5560",
    "notes": null,
    "routes": [
      {
        "id": 1,
        "name": "Route 01"
      },
      {
        "id": 2,
        "name": "Other route"
      }
    ]
  }
]

Ver

GET /api/v1//pick_lists/[id]

Parâmetros de URL:

parâmetro	descrição	obrigatório
id	id da pick list	sim

Exemplo:

GET /api/v1/pick_lists/[id]

Retorno

status	descrição
200	OK

Exemplo:

{
  "id": 4164,
  "created_at": "2015-11-09T07:49:34.000-02:00",
  "updated_at": "2015-11-09T12:40:13.000-02:00",
  "planogram_id": 2477,
  "group_id": 1,
  "distribution_center_id": 1,
  "supply_category_id": 1,
  "separate_status": "separated",
  "pending": false,
  "status": "applied",
  "notes": "some extra info",
  "items": [
    {
      "id": 167188,
      "planogram_item_id": 93477,
      "quantity": 8,
      "ignored": true,
      "ignore_reason": "Estoque disponível insuficiente",
      "good_id": 2229,
      "barcodes": ["3568765432158", "9876543211658", "9876543212845"]
    },
    {
      "id": 167190,
      "planogram_item_id": 93479,
      "quantity": 3,
      "ignored": false,
      "good_id": 543,
      "barcodes": ["2345678900045"]
    },
    {
      "id": 167191,
      "planogram_item_id": 93480,
      "quantity": 3,
      "ignored": false,
      "good_id": 533,
      "barcodes": ["1287453612345"]
    },
    {
      "id":167192
      "planogram_item_id":93481,
      "quantity":12,
      "ignored":false,
      "packing_quantity":1,
      "good_id":2225,
      "barcodes": ["3265147898652"]
    },
    {
      "id": 167193,
      "planogram_item_id": 93482,
      "quantity": 2,
      "ignored": false,
      "good_id": 533,
      "barcodes": ["3256983216954"]
    }
  ]
  "routes": [
    {
      "id": 1,
      "name": "Route 01"
    },
    {
      "id": 2,
      "name": "Other route"
    }
  ]
}

Erros

status	descrição	response body
404	pick list não encontrada	{ “status”: “404”, “error”: “Not Found” }