Listar todas as orders

Get all orders of a company

curl --request GET \
  --url https://api.cliquepay.app/order

[
  {
    "id": "6d8e25d3-7eb5-4afe-9db9-9c63eb231298",
    "orderNumber": "ORD123",
    "status": "CREATED",
    "subtotal": "100.50",
    "discount": "10.00",
    "shippingCost": "15.00",
    "total": "105.50",
    "paymentStatus": "PENDING",
    "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
    "company": {
      "id": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "name": "Empresa Bola",
      "cpfCnpj": "36062381000180",
      "status": "ACTIVE",
      "storeType": "FISICA",
      "needGatewaySetup": "false",
      "createdAt": "2025-02-03T10:00:00Z",
      "updatedAt": "2025-02-03T10:00:00Z",
      "checkoutPreferences": {
        "logo": "https://example.com/logo.png",
        "backgroundColor": "#FFFFFF",
        "bannerColor": "#000000",
        "bannerText": "Welcome to our store!",
        "checkoutStyle": "CONVERSION",
        "pix": true,
        "boleto": true,
        "creditCard": true,
        "timer": true,
        "timerMinutes": 10,
        "pixDiscount": 10,
        "delivery": true,
        "companyId": "550e8400-e29b-41d4-a716-446655440000",
        "productId": "550e8400-e29b-41d4-a716-446655440000",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "createdAt": "2024-02-15T12:34:56Z",
        "productOrderBump": "2024-02-16T12:34:56Z",
        "updatedAt": "2024-02-16T12:34:56Z"
      }
    },
    "orderItems": [
      {
        "id": "6d8e25d3-7eb5-4afe-9db9-9c63eb231298",
        "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
        "productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "orderId": "b1c2d3e4-f5g6-7890-hijk-lm9876543210",
        "quantity": 1,
        "createdAt": "2025-02-03T10:00:00Z",
        "updatedAt": "2025-02-03T10:00:00Z",
        "product": {
          "id": "0e02a425-32b4-493d-8db6-1a033457b5ee",
          "name": "Produto Bola",
          "description": "Produto muito bom",
          "price": 19.9,
          "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
          "status": "ACTIVE",
          "isSubscription": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "sku": "ABCD",
          "displayId": "bolaABCD",
          "shopifyVariantId": "3439480320342",
          "imageUrl": "https://example.com/image.png",
          "defaultPeriod": "MONTHLY",
          "defaultTrialDays": 14
        }
      }
    ],
    "createdAt": "2025-02-03T10:00:00Z",
    "updatedAt": "2025-02-03T10:00:00Z",
    "cpfCnpj": "12345678900",
    "name": "João Silva",
    "email": "[email protected]",
    "phone": "11999999999",
    "shippingAddress": {},
    "postalCode": "12345678",
    "street": "Rua Principal",
    "number": "123",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "complement": "Apto 123",
    "addressType": "RESIDENTIAL",
    "paymentMethod": "PIX",
    "installments": 1,
    "paymentDate": "2023-11-07T05:31:56Z",
    "shippingMethod": "SEDEX",
    "trackingUrl": "https://tracking.com",
    "deliveryDate": "2023-11-07T05:31:56Z",
    "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "client": {
      "id": "0502ef53-ddc3-429b-b480-01cb1bbd81e0",
      "cpfCnpj": "05305405364",
      "name": "Cliente Bola",
      "email": "[email protected]",
      "phone": "41999999999",
      "status": "ACTIVE",
      "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "createdAt": "2025-02-03T10:00:00Z",
      "updatedAt": "2025-02-03T10:00:00Z"
    },
    "sales": {
      "id": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "orderId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "value": 100,
      "totalValue": 110,
      "checkoutFee": 5,
      "gatewayFee": 5,
      "createdAt": "2025-04-15T10:00:00Z",
      "updatedAt": "2025-04-15T10:00:00Z",
      "order": "f96a489c-8a4d-4c7b-a1f6-347acbd832df"
    },
    "isShopifyOrder": true,
    "shopifyOrderId": "<string>",
    "notes": "Observações sobre o pedido"
  }
]

GET

order

Get all orders of a company

curl --request GET \
  --url https://api.cliquepay.app/order

[
  {
    "id": "6d8e25d3-7eb5-4afe-9db9-9c63eb231298",
    "orderNumber": "ORD123",
    "status": "CREATED",
    "subtotal": "100.50",
    "discount": "10.00",
    "shippingCost": "15.00",
    "total": "105.50",
    "paymentStatus": "PENDING",
    "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
    "company": {
      "id": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "name": "Empresa Bola",
      "cpfCnpj": "36062381000180",
      "status": "ACTIVE",
      "storeType": "FISICA",
      "needGatewaySetup": "false",
      "createdAt": "2025-02-03T10:00:00Z",
      "updatedAt": "2025-02-03T10:00:00Z",
      "checkoutPreferences": {
        "logo": "https://example.com/logo.png",
        "backgroundColor": "#FFFFFF",
        "bannerColor": "#000000",
        "bannerText": "Welcome to our store!",
        "checkoutStyle": "CONVERSION",
        "pix": true,
        "boleto": true,
        "creditCard": true,
        "timer": true,
        "timerMinutes": 10,
        "pixDiscount": 10,
        "delivery": true,
        "companyId": "550e8400-e29b-41d4-a716-446655440000",
        "productId": "550e8400-e29b-41d4-a716-446655440000",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "createdAt": "2024-02-15T12:34:56Z",
        "productOrderBump": "2024-02-16T12:34:56Z",
        "updatedAt": "2024-02-16T12:34:56Z"
      }
    },
    "orderItems": [
      {
        "id": "6d8e25d3-7eb5-4afe-9db9-9c63eb231298",
        "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
        "productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "orderId": "b1c2d3e4-f5g6-7890-hijk-lm9876543210",
        "quantity": 1,
        "createdAt": "2025-02-03T10:00:00Z",
        "updatedAt": "2025-02-03T10:00:00Z",
        "product": {
          "id": "0e02a425-32b4-493d-8db6-1a033457b5ee",
          "name": "Produto Bola",
          "description": "Produto muito bom",
          "price": 19.9,
          "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
          "status": "ACTIVE",
          "isSubscription": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "sku": "ABCD",
          "displayId": "bolaABCD",
          "shopifyVariantId": "3439480320342",
          "imageUrl": "https://example.com/image.png",
          "defaultPeriod": "MONTHLY",
          "defaultTrialDays": 14
        }
      }
    ],
    "createdAt": "2025-02-03T10:00:00Z",
    "updatedAt": "2025-02-03T10:00:00Z",
    "cpfCnpj": "12345678900",
    "name": "João Silva",
    "email": "[email protected]",
    "phone": "11999999999",
    "shippingAddress": {},
    "postalCode": "12345678",
    "street": "Rua Principal",
    "number": "123",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "complement": "Apto 123",
    "addressType": "RESIDENTIAL",
    "paymentMethod": "PIX",
    "installments": 1,
    "paymentDate": "2023-11-07T05:31:56Z",
    "shippingMethod": "SEDEX",
    "trackingUrl": "https://tracking.com",
    "deliveryDate": "2023-11-07T05:31:56Z",
    "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "client": {
      "id": "0502ef53-ddc3-429b-b480-01cb1bbd81e0",
      "cpfCnpj": "05305405364",
      "name": "Cliente Bola",
      "email": "[email protected]",
      "phone": "41999999999",
      "status": "ACTIVE",
      "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "createdAt": "2025-02-03T10:00:00Z",
      "updatedAt": "2025-02-03T10:00:00Z"
    },
    "sales": {
      "id": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "orderId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "value": 100,
      "totalValue": 110,
      "checkoutFee": 5,
      "gatewayFee": 5,
      "createdAt": "2025-04-15T10:00:00Z",
      "updatedAt": "2025-04-15T10:00:00Z",
      "order": "f96a489c-8a4d-4c7b-a1f6-347acbd832df"
    },
    "isShopifyOrder": true,
    "shopifyOrderId": "<string>",
    "notes": "Observações sobre o pedido"
  }
]

Response

200 - application/json

All orders of a company in App

string

required

ID do pedido

Example:

"6d8e25d3-7eb5-4afe-9db9-9c63eb231298"

orderNumber

string

required

Número do pedido

Example:

"ORD123"

status

enum<string>

required

Status do pedido

Opções disponíveis:

CREATED,

PROCESSING,

EXPIRED,

DONE

Example:

"CREATED"

subtotal

number

required

Subtotal do pedido

Example:

"100.50"

discount

number

required

Desconto aplicado

Example:

"10.00"

shippingCost

number

required

Custo do frete

Example:

"15.00"

total

number

required

Valor total do pedido

Example:

"105.50"

paymentStatus

enum<string>

required

Status do pagamento

Opções disponíveis:

PENDING,

PAID,

FAILED,

REFUNDED,

CANCELLED

Example:

"PENDING"

companyId

string

required

ID da empresa

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

company

object

required

Mostrar atributos filhos

company.id

string

required

Company id

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

company.name

string

required

Company Name

Example:

"Empresa Bola"

company.cpfCnpj

string

required

Company Name

Example:

"36062381000180"

company.status

string

required

Company Status

Example:

"ACTIVE"

company.storeType

string

required

Company fiscal type

Example:

"FISICA"

company.needGatewaySetup

boolean

required

If a company needs gateway setup

Example:

"false"

company.createdAt

string<date-time>

required

Company created at date

Example:

"2025-02-03T10:00:00Z"

company.updatedAt

string<date-time>

required

Company updated at date

Example:

"2025-02-03T10:00:00Z"

company.checkoutPreferences

object

Company checkout preferences

Mostrar atributos filhos

company.checkoutPreferences.logo

string

Logo URL

Example:

"https://example.com/logo.png"

company.checkoutPreferences.backgroundColor

string

Background color in HEX format

Example:

"#FFFFFF"

company.checkoutPreferences.bannerColor

string

Banner color in HEX format

Example:

"#000000"

company.checkoutPreferences.bannerText

string

Text displayed on the banner

Example:

"Welcome to our store!"

company.checkoutPreferences.checkoutStyle

string

Checkout template

Example:

"CONVERSION"

company.checkoutPreferences.pix

boolean

If checkout should accept PIX payment

Example:

true

company.checkoutPreferences.boleto

boolean

If checkout should accept Boleto payment

Example:

true

company.checkoutPreferences.creditCard

boolean

If checkout should accept Credit Card payment

Example:

true

company.checkoutPreferences.timer

boolean

Indicates if the timer is enabled

Example:

true

company.checkoutPreferences.timerMinutes

number

How many minutes the timer should use

Example:

10

company.checkoutPreferences.pixDiscount

number

pix discount in percentage

Example:

10

company.checkoutPreferences.delivery

boolean

Indicates if delivery is available

Example:

true

company.checkoutPreferences.companyId

string

Unique identifier of the associated company

Example:

"550e8400-e29b-41d4-a716-446655440000"

company.checkoutPreferences.productId

object

Unique identifier of the associated product to make the order bump

Example:

"550e8400-e29b-41d4-a716-446655440000"

company.checkoutPreferences.id

string

Unique identifier of the checkout preferences

Example:

"550e8400-e29b-41d4-a716-446655440000"

company.checkoutPreferences.createdAt

string<date-time>

Creation timestamp

Example:

"2024-02-15T12:34:56Z"

company.checkoutPreferences.productOrderBump

object

product

Mostrar atributos filhos

company.checkoutPreferences.productOrderBump.id

string

required

Example:

"0e02a425-32b4-493d-8db6-1a033457b5ee"

company.checkoutPreferences.productOrderBump.name

string

required

Example:

"Produto Bola"

company.checkoutPreferences.productOrderBump.description

string

required

Example:

"Produto muito bom"

company.checkoutPreferences.productOrderBump.price

number

required

Example:

19.9

company.checkoutPreferences.productOrderBump.companyId

string

required

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

company.checkoutPreferences.productOrderBump.status

string

required

Example:

"ACTIVE"

company.checkoutPreferences.productOrderBump.isSubscription

boolean

required

Example:

true

company.checkoutPreferences.productOrderBump.createdAt

string<date-time>

required

company.checkoutPreferences.productOrderBump.updatedAt

string<date-time>

required

company.checkoutPreferences.productOrderBump.sku

string

Example:

"ABCD"

company.checkoutPreferences.productOrderBump.displayId

string

Example:

"bolaABCD"

company.checkoutPreferences.productOrderBump.shopifyVariantId

string

Example:

"3439480320342"

company.checkoutPreferences.productOrderBump.imageUrl

string

Example:

"https://example.com/image.png"

company.checkoutPreferences.productOrderBump.defaultPeriod

string

Example:

"MONTHLY"

company.checkoutPreferences.productOrderBump.defaultTrialDays

number

Example:

14

Example:

"2024-02-16T12:34:56Z"

company.checkoutPreferences.updatedAt

string<date-time>

Last update timestamp

Example:

"2024-02-16T12:34:56Z"

orderItems

object[]

required

Mostrar atributos filhos

orderItems.id

string

required

Order item ID

Example:

"6d8e25d3-7eb5-4afe-9db9-9c63eb231298"

orderItems.companyId

string

required

Company ID

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

orderItems.productId

string

required

Product ID

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

orderItems.orderId

string

required

Order ID

Example:

"b1c2d3e4-f5g6-7890-hijk-lm9876543210"

orderItems.quantity

number

required

Quantity

Example:

1

orderItems.createdAt

string<date-time>

required

Created at date

Example:

"2025-02-03T10:00:00Z"

orderItems.updatedAt

string<date-time>

required

Updated at date

Example:

"2025-02-03T10:00:00Z"

orderItems.product

object

Product

Mostrar atributos filhos

orderItems.product.id

string

required

Example:

"0e02a425-32b4-493d-8db6-1a033457b5ee"

orderItems.product.name

string

required

Example:

"Produto Bola"

orderItems.product.description

string

required

Example:

"Produto muito bom"

orderItems.product.price

number

required

Example:

19.9

orderItems.product.companyId

string

required

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

orderItems.product.status

string

required

Example:

"ACTIVE"

orderItems.product.isSubscription

boolean

required

Example:

true

orderItems.product.createdAt

string<date-time>

required

orderItems.product.updatedAt

string<date-time>

required

orderItems.product.sku

string

Example:

"ABCD"

orderItems.product.displayId

string

Example:

"bolaABCD"

orderItems.product.shopifyVariantId

string

Example:

"3439480320342"

orderItems.product.imageUrl

string

Example:

"https://example.com/image.png"

orderItems.product.defaultPeriod

string

Example:

"MONTHLY"

orderItems.product.defaultTrialDays

number

Example:

14

createdAt

string<date-time>

required

Data de criação

Example:

"2025-02-03T10:00:00Z"

updatedAt

string<date-time>

required

Data de atualização

Example:

"2025-02-03T10:00:00Z"

cpfCnpj

string

CPF/CNPJ do cliente

Example:

"12345678900"

name

string

Nome do cliente

Example:

"João Silva"

string

Email do cliente

Example:

"[email protected]"

phone

string

Telefone do cliente

Example:

"11999999999"

shippingAddress

object

Endereço de entrega completo em formato JSON

postalCode

string

CEP de entrega

Example:

"12345678"

street

string

Rua de entrega

Example:

"Rua Principal"

number

string

Número do endereço

Example:

"123"

neighborhood

string

Bairro

Example:

"Centro"

city

string

Cidade

Example:

"São Paulo"

state

string

Estado

Example:

"SP"

complement

string

Complemento do endereço

Example:

"Apto 123"

addressType

enum<string>

Tipo do endereço

Opções disponíveis:

RESIDENTIAL,

COMMERCIAL

Example:

"RESIDENTIAL"

paymentMethod

enum<string>

Método de pagamento

Opções disponíveis:

PIX,

CREDIT_CARD,

BOLETO

Example:

"PIX"

installments

number

Número de parcelas

Example:

1

paymentDate

string<date-time>

Data do pagamento

shippingMethod

string

Método de entrega

Example:

"SEDEX"

trackingUrl

string

URL de rastreamento

Example:

"https://tracking.com"

deliveryDate

string<date-time>

Data de entrega prevista

clientId

string

ID do cliente

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

client

object

Mostrar atributos filhos

client.id

string

required

Client id

Example:

"0502ef53-ddc3-429b-b480-01cb1bbd81e0"

client.cpfCnpj

string

required

Client id

Example:

"05305405364"

client.name

string

required

Client Name

Example:

"Cliente Bola"

client.email

string

required

Client Email

Example:

"[email protected]"

client.phone

string

required

Client Phone

Example:

"41999999999"

client.status

string

required

Client Status

Example:

"ACTIVE"

client.companyId

string

required

Company id

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

client.createdAt

string<date-time>

required

Client created at date

Example:

"2025-02-03T10:00:00Z"

client.updatedAt

string<date-time>

required

Client updated at date

Example:

"2025-02-03T10:00:00Z"

sales

object

Mostrar atributos filhos

sales.id

string

required

ID único da venda

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

sales.companyId

string

required

ID da empresa relacionada à venda

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

sales.orderId

string

required

ID do pedido relacionado à venda

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

sales.value

number

required

Valor base da venda

Example:

100

sales.totalValue

number

required

Valor total da venda incluindo taxas

Example:

110

sales.checkoutFee

number

required

Taxa do checkout aplicada à venda

Example:

5

sales.gatewayFee

number

required

Taxa do gateway de pagamento aplicada à venda

Example:

5

sales.createdAt

string<date-time>

required

Data de criação da venda

Example:

"2025-04-15T10:00:00Z"

sales.updatedAt

string<date-time>

required

Data da última atualização da venda

Example:

"2025-04-15T10:00:00Z"

sales.order

object

ID do pedido relacionado à venda

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

isShopifyOrder

boolean

shopifyOrderId

string

notes

string

Notas ou observações

Example:

"Observações sobre o pedido"

Criar uma nova order Atualizar uma order

⌘I

Introdução

Order

Client

Cupon

Products

Subscriptions

Webhooks

Listar todas as orders

Response