API legada/Referência completa/Missões de campo

Missões

Lista as missões dos promotores agrupadas por promotor e seller, e recebe a atualização de uma missão.

A lista agrupa as missões por promotor e, dentro dele, por seller. Hoje a lista vem sempre vazia e a atualização responde 501 (veja a visão geral).

Listar missões

GET/api/v1.0/missionsAdmin

Listar missões de campo

Sem parâmetros. Devolve todas as missões.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/missions"

Resposta

200Missões (hoje, lista vazia)

json

{
  "status": 200,
  "data": []
}

Quando houver missões, cada item de data tem este formato:

json

{
  "salesPromoterId": "42",
  "sellers": [
    {
      "sellerId": "7",
      "missions": [
        { "missionid": "310", "title": "Foto da gôndola", "description": "Fotografar a gôndola de bebidas", "status": "A" }
      ]
    }
  ]
}

Campos da resposta

salesPromoterIdstring

Id do promotor.

sellersarray

Sellers atendidos pelo promotor.

sellers[].sellerIdstring

Id do seller.

sellers[].missionsarray

Missões do promotor naquele seller: missionid, title, description e status, todos em texto.

Atualizar missão

PUT/api/v1.0/missions/{id}Admin

Atualizar uma missão (não implementado)

Aceita um corpo JSON qualquer e responde 501. Nada é gravado.

Parâmetros de caminho

idstringobrigatório

Id da missão.

Corpo da requisição

*object

Objeto JSON livre. O conteúdo é lido e descartado.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X PUT "$BASE_URL/api/v1.0/missions/7c1d0f55-2a8e-4b9a-b3c4-5d6e7f8a9b01" \
  -H "Content-Type: application/json" \
  -d '{"status":"done"}'

Resposta

501Não implementado

json

{
  "status": 501,
  "message": "Missions update is not implemented yet ...",
  "mission_id": "7c1d0f55-2a8e-4b9a-b3c4-5d6e7f8a9b01"
}

O texto de message é em inglês e pode mudar; use o status 501.

Erros

Status	Quando	Corpo de exemplo
401	Sem credencial.	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	Credencial válida, mas de quem não é administrador.	`{"message":"Forbidden: admin scope required","status":403}`
404	O módulo do conector Magento está desligado na loja.	`{"message":"endpoint not available","status":404}`
400	Corpo que não é JSON.	`{"message":"invalid request body","status":400}`
501	Sempre, quando o módulo está ligado.	`{"status":501,"message":"Missions update is not implemented yet ...","mission_id":"7c1d0f55-2a8e-4b9a-b3c4-5d6e7f8a9b01"}`

Veja também

Missões

Lista as missões dos promotores agrupadas por promotor e seller, e recebe a atualização de uma missão.

A lista agrupa as missões por promotor e, dentro dele, por seller. Hoje a lista vem sempre vazia e a atualização responde 501 (veja a visão geral).

Listar missões

GET/api/v1.0/missionsAdmin

Listar missões de campo

Sem parâmetros. Devolve todas as missões.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/missions"

Resposta

200Missões (hoje, lista vazia)

json

{
  "status": 200,
  "data": []
}

Quando houver missões, cada item de data tem este formato:

json

{
  "salesPromoterId": "42",
  "sellers": [
    {
      "sellerId": "7",
      "missions": [
        { "missionid": "310", "title": "Foto da gôndola", "description": "Fotografar a gôndola de bebidas", "status": "A" }
      ]
    }
  ]
}

Campos da resposta

salesPromoterIdstring

Id do promotor.

sellersarray

Sellers atendidos pelo promotor.

sellers[].sellerIdstring

Id do seller.

sellers[].missionsarray

Missões do promotor naquele seller: missionid, title, description e status, todos em texto.

Atualizar missão

PUT/api/v1.0/missions/{id}Admin

Atualizar uma missão (não implementado)

Aceita um corpo JSON qualquer e responde 501. Nada é gravado.

Parâmetros de caminho

idstringobrigatório

Id da missão.

Corpo da requisição

*object

Objeto JSON livre. O conteúdo é lido e descartado.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X PUT "$BASE_URL/api/v1.0/missions/7c1d0f55-2a8e-4b9a-b3c4-5d6e7f8a9b01" \
  -H "Content-Type: application/json" \
  -d '{"status":"done"}'

Resposta

501Não implementado

json

{
  "status": 501,
  "message": "Missions update is not implemented yet ...",
  "mission_id": "7c1d0f55-2a8e-4b9a-b3c4-5d6e7f8a9b01"
}

O texto de message é em inglês e pode mudar; use o status 501.

Erros

Status	Quando	Corpo de exemplo
401	Sem credencial.	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	Credencial válida, mas de quem não é administrador.	`{"message":"Forbidden: admin scope required","status":403}`
404	O módulo do conector Magento está desligado na loja.	`{"message":"endpoint not available","status":404}`
400	Corpo que não é JSON.	`{"message":"invalid request body","status":400}`
501	Sempre, quando o módulo está ligado.	`{"status":501,"message":"Missions update is not implemented yet ...","mission_id":"7c1d0f55-2a8e-4b9a-b3c4-5d6e7f8a9b01"}`