YAyampi
Busca - Pedidos

Listar Pedidos retornados pela busca

Changed on

lista pedidos retornados pela busca

get/{alias}/search/orders

Request

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

Path parameters

aliasstring required

Alias da loja

Query parameters

freebie_idinteger[]

Brindes associados ao pedido.

order_bump_idinteger[]

Order Bumps adicionados ao pedido.

cashbackstring[]

Filtra pedidos por status de cashback.

upsell_idinteger[]

Upsells adquiridos após o checkout.

woocommercestring[]

Filtra pedidos sincronizados ou não com WooCommerce.

utm_sourcestring[]

Origem da campanha de marketing (UTM Source).

shopify_idinteger

Busca pedido pelo ID do pedido na Shopify.

utm_campaignstring[]

Nome da campanha de marketing (UTM Campaign).

customer_documentstring

Documento do cliente associado ao pedido (CPF ou CNPJ).

Filtros de pedidos

{
  "customer_document": "?customer_document=12345678900"
}

Response

Lista de pedidos através da busca

Example response

{
  "data": {
    "transactions": {
      "data": {
        "created_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "updated_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "capture_date": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "authorized_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "captured_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "cancelled_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "metadata": [
          {
            "key": "discount_highlight",
            "value": "pix"
          }
        ]
      }
    },
    "date_delivery": {
      "date": "2000-08-17 10:24:24",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "metadata": {
      "data": [
        {
          "key": "discount_highlight",
          "value": "pix"
        }
      ]
    },
    "promocode": {
      "data": {
        "code": "TEST",
        "value": 10,
        "used": 22,
        "min_value": 99.99,
        "use_percent": 0.02,
        "payments_ids": "[1, 2, 3, 4]",
        "start_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "end_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "created_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "updated_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        }
      }
    },
    "statuses": {
      "data": [
        {
          "created_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "updated_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          }
        }
      ]
    },
    "customer": {
      "data": {
        "spreadsheet": {
          "data": {
            "phone": "(16) 98187-5668",
            "phone_number": "981875668",
            "phone_code": "16"
          }
        }
      }
    }
  }
}

Changes