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

Pesquisas de campo

Lista as pesquisas de preço dos promotores por campanha e recebe a atualização de uma pesquisa.

Cada pesquisa pertence a um promotor e a uma campanha. Dentro da campanha, cada visita (identificada por um searchIdentifierCode) lista os produtos pesquisados num seller, com a quantidade e dois preços coletados. Hoje a lista vem sempre vazia e a atualização responde 501 (veja a visão geral).

Listar pesquisas

GET/api/v1.0/mission_surveysAdmin

Listar pesquisas de campo

Sem parâmetros. Devolve todas as pesquisas.

GET/api/v1.0/missionsurveysAdmin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/mission_surveys. Use este caminho se o seu cliente já foi escrito para ele (o nome da entidade sem o sublinhado).

Exemplo de requisição

bash

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

Resposta

200Pesquisas (hoje, lista vazia)

json

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

Quando houver pesquisas, cada item de data tem este formato:

json

{
  "salesPromoterId": "42",
  "campaigns": {
    "campaignName": "Verão 2026",
    "details": [
      {
        "searchIdentifierCode": "SRCH-2026-0042",
        "sellerId": "7",
        "products": [
          {
            "productSku": "CAN-350-AZ",
            "quantitySearched": "3",
            "productName": "Caneca Esmaltada 350 ml",
            "productId": "0497b6a8-c868-43be-ac21-2abddd24cd3c",
            "productImage": "",
            "price1": "49.90",
            "price2": "52.90"
          }
        ]
      }
    ]
  }
}

Campos da resposta

salesPromoterIdstring

Id do promotor.

campaigns.campaignNamestring

Nome da campanha.

campaigns.details[].searchIdentifierCodestring

Código que identifica a visita.

campaigns.details[].sellerIdstring

Id do seller visitado.

campaigns.details[].products[]object

Produtos pesquisados: productSku, productName, productId, productImage, quantitySearched e os preços price1 e price2, todos em texto (preços em texto decimal).

Atualizar pesquisa

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

Atualizar uma pesquisa (não implementado)

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

Parâmetros de caminho

idstringobrigatório

Código da pesquisa (searchIdentifierCode).

Corpo da requisição

*object

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

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

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/mission_surveys/{id}. Use este caminho se o seu cliente já foi escrito para ele (o nome da entidade sem o sublinhado).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X PUT "$BASE_URL/api/v1.0/mission_surveys/SRCH-2026-0042" \
  -H "Content-Type: application/json" \
  -d '{"productSku":"CAN-350-AZ","quantitySearched":"3","price1":"49.90"}'

Resposta

501Não implementado

json

{
  "status": 501,
  "message": "MissionSurveys update is not implemented yet ...",
  "searchIdentifierCode": "SRCH-2026-0042"
}

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":"MissionSurveys update is not implemented yet ...","searchIdentifierCode":"SRCH-2026-0042"}`

Veja também

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

Pesquisas de campo

Lista as pesquisas de preço dos promotores por campanha e recebe a atualização de uma pesquisa.

Listar pesquisas

GET/api/v1.0/mission_surveysAdmin

Listar pesquisas de campo

Sem parâmetros. Devolve todas as pesquisas.

GET/api/v1.0/missionsurveysAdmin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/mission_surveys. Use este caminho se o seu cliente já foi escrito para ele (o nome da entidade sem o sublinhado).

Exemplo de requisição

bash

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

Resposta

200Pesquisas (hoje, lista vazia)

json

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

Quando houver pesquisas, cada item de data tem este formato:

json

{
  "salesPromoterId": "42",
  "campaigns": {
    "campaignName": "Verão 2026",
    "details": [
      {
        "searchIdentifierCode": "SRCH-2026-0042",
        "sellerId": "7",
        "products": [
          {
            "productSku": "CAN-350-AZ",
            "quantitySearched": "3",
            "productName": "Caneca Esmaltada 350 ml",
            "productId": "0497b6a8-c868-43be-ac21-2abddd24cd3c",
            "productImage": "",
            "price1": "49.90",
            "price2": "52.90"
          }
        ]
      }
    ]
  }
}

Campos da resposta

salesPromoterIdstring

Id do promotor.

campaigns.campaignNamestring

Nome da campanha.

campaigns.details[].searchIdentifierCodestring

Código que identifica a visita.

campaigns.details[].sellerIdstring

Id do seller visitado.

campaigns.details[].products[]object

Produtos pesquisados: productSku, productName, productId, productImage, quantitySearched e os preços price1 e price2, todos em texto (preços em texto decimal).

Atualizar pesquisa

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

Atualizar uma pesquisa (não implementado)

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

Parâmetros de caminho

idstringobrigatório

Código da pesquisa (searchIdentifierCode).

Corpo da requisição

*object

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

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

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/mission_surveys/{id}. Use este caminho se o seu cliente já foi escrito para ele (o nome da entidade sem o sublinhado).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X PUT "$BASE_URL/api/v1.0/mission_surveys/SRCH-2026-0042" \
  -H "Content-Type: application/json" \
  -d '{"productSku":"CAN-350-AZ","quantitySearched":"3","price1":"49.90"}'

Resposta

501Não implementado

json

{
  "status": 501,
  "message": "MissionSurveys update is not implemented yet ...",
  "searchIdentifierCode": "SRCH-2026-0042"
}

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":"MissionSurveys update is not implemented yet ...","searchIdentifierCode":"SRCH-2026-0042"}`