YAyampi
Filas

Atualizar fila

Changed on

Atualiza os detalhes de uma fila específica

put/{alias}/queues/{id}

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/queues/{id}
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

idinteger required

ID da fila

Request body

tokenstring

Token único da fila, usado para consultar o andamento do processamento.

total_sentinteger

Quantidade total de registros enviados para processamento na fila.

total_processedinteger

Quantidade de registros já processados; quando igual ou maior que total_sent, a fila é considerada concluída.

titlestring

Título de exibição da fila, indicando a operação em andamento.

redirect_urlstring

URL para onde o usuário é direcionado ao final do processamento da fila.

finished_atstring date-time

Data e hora em que o processamento da fila foi concluído.

Example request

{
  "token": "ecd73150-e747-11e7-9221-0361c8d4d388",
  "total_sent": 5,
  "total_processed": 5,
  "title": "Importing products",
  "redirect_url": "https://site.com",
  "finished_at": "2017-04-03 00:00:00"
}

Response

Fila atualizada com sucesso

idinteger

ID da fila.

store_idinteger

ID da loja dona da fila.

user_idinteger

ID do usuário que iniciou o processamento da fila.

tokenstring

Token único da fila, usado para consultar o andamento do processamento.

total_sentinteger

Quantidade total de registros enviados para processamento na fila.

total_processedinteger

Quantidade de registros já processados; quando igual ou maior que total_sent, a fila é considerada concluída.

titlestring

Título de exibição da fila, indicando a operação em andamento.

redirect_urlstring

URL para onde o usuário é direcionado ao final do processamento da fila.

finished_atstring date-time

Data e hora em que o processamento da fila foi concluído.

created_atstring date-time

Data e hora de criação da fila.

updated_atstring date-time

Data e hora da última atualização da fila.

Example response

{
  "token": "ecd73150-e747-11e7-9221-0361c8d4d388",
  "total_sent": 5,
  "total_processed": 5,
  "title": "Importando produtos",
  "redirect_url": "https://site.com",
  "finished_at": "2017-04-03 00:00:00",
  "created_at": "2017-04-03 00:00:00",
  "updated_at": "2017-04-03 00:00:00"
}

Changes