sales.by_reference

Achar a venda pela referência. Devolve o id do pedido de plataforma com o código externalId (a tela abre o detalhe dele). not_found se nenhum pedido tem esse código.

• Endpoint: POST https://app.atomiks.com.br/api/v1/sales.by_reference (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: crm:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: sales_by_reference
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId sales.by_reference)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "externalId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "externalId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/sales.by_reference \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"externalId":"HP12345678"}'

CLI:

node cli/atomiks.mjs sales.by_reference --json '{"externalId":"HP12345678"}'

MCP: ferramenta sales_by_reference com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).