Pular para o conteúdo principal
POST
/
order
Create a Order
curl --request POST \
  --url https://api.cliquepay.app/order \
  --header 'Content-Type: application/json' \
  --data '{
  "subtotal": "100.50",
  "discount": "10.00",
  "shippingCost": "15.00",
  "total": "125.50",
  "companyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "João Silva",
  "email": "joao@email.com",
  "phone": "11999999999",
  "cpfCnpj": "12345678900",
  "postalCode": "12345678",
  "street": "Rua Principal",
  "number": "123",
  "neighborhood": "Centro",
  "city": "São Paulo",
  "state": "SP",
  "complement": "Apto 123",
  "addressType": "RESIDENTIAL",
  "paymentMethod": "PIX",
  "installments": 1,
  "shippingMethod": "SEDEX",
  "items": [
    {
      "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "orderId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "quantity": 1
    }
  ],
  "notes": "Observações sobre o pedido",
  "paymentDate": "2023-11-07T05:31:56Z",
  "trackingCode": "<string>",
  "trackingUrl": "<string>",
  "isShopifyOrder": true,
  "shopifyOrderId": "<string>"
}'
{
  "id": "6d8e25d3-7eb5-4afe-9db9-9c63eb231298",
  "orderNumber": "ORD123",
  "status": "CREATED",
  "subtotal": "100.50",
  "discount": "10.00",
  "shippingCost": "15.00",
  "total": "105.50",
  "cpfCnpj": "12345678900",
  "name": "João Silva",
  "email": "joao@email.com",
  "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",
  "paymentStatus": "PENDING",
  "installments": 1,
  "paymentDate": "2023-11-07T05:31:56Z",
  "shippingMethod": "SEDEX",
  "trackingUrl": "https://tracking.com",
  "deliveryDate": "2023-11-07T05:31:56Z",
  "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
  "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "client": {
    "id": "0502ef53-ddc3-429b-b480-01cb1bbd81e0",
    "cpfCnpj": "05305405364",
    "name": "Cliente Bola",
    "email": "bola@email.com",
    "phone": "41999999999",
    "status": "ACTIVE",
    "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
    "createdAt": "2025-02-03T10:00:00Z",
    "updatedAt": "2025-02-03T10:00:00Z"
  },
  "company": {
    "id": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
    "name": "Empresa Bola",
    "cpfCnpj": "36062381000180",
    "status": "ACTIVE",
    "storeType": "FISICA",
    "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"
    },
    "needGatewaySetup": "false",
    "createdAt": "2025-02-03T10:00:00Z",
    "updatedAt": "2025-02-03T10:00:00Z"
  },
  "orderItems": [
    {
      "id": "6d8e25d3-7eb5-4afe-9db9-9c63eb231298",
      "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
      "productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "product": {
        "id": "0e02a425-32b4-493d-8db6-1a033457b5ee",
        "name": "Produto Bola",
        "description": "Produto muito bom",
        "price": 19.9,
        "sku": "ABCD",
        "displayId": "bolaABCD",
        "shopifyVariantId": "3439480320342",
        "imageUrl": "https://example.com/image.png",
        "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
        "status": "ACTIVE",
        "isSubscription": true,
        "defaultPeriod": "MONTHLY",
        "defaultTrialDays": 14,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "orderId": "b1c2d3e4-f5g6-7890-hijk-lm9876543210",
      "quantity": 1,
      "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",
    "order": "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"
  },
  "isShopifyOrder": true,
  "shopifyOrderId": "<string>",
  "notes": "Observações sobre o pedido",
  "createdAt": "2025-02-03T10:00:00Z",
  "updatedAt": "2025-02-03T10:00:00Z"
}

Body

application/json
​
subtotal
number
required

Subtotal do pedido

Example:

"100.50"

​
total
number
required

Valor total do pedido

Example:

"125.50"

​
discount
number

Valor do desconto

Example:

"10.00"

​
shippingCost
number

Custo do frete

Example:

"15.00"

​
companyId
string

ID da empresa

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
clientId
string

ID do cliente

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
name
string

Nome do cliente

Example:

"João Silva"

​
email
string

Email do cliente

Example:

"joao@email.com"

​
phone
string

Telefone do cliente

Example:

"11999999999"

​
cpfCnpj
string

CPF/CNPJ do cliente

Example:

"12345678900"

​
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

Available options:
RESIDENTIAL,
COMMERCIAL
Example:

"RESIDENTIAL"

​
paymentMethod
enum<string>

Método de pagamento

Available options:
PIX,
CREDIT_CARD,
BOLETO
Example:

"PIX"

​
installments
number

Número de parcelas

Example:

1

​
shippingMethod
string

Método de entrega

Example:

"SEDEX"

​
items
object[]

Itens do pedido

​
notes
string

Notas ou observações

Example:

"Observações sobre o pedido"

​
paymentDate
string<date-time>

Data do pagamento

​
trackingCode
string

Data do pagamento

​
trackingUrl
string

Data do pagamento

​
isShopifyOrder
boolean
​
shopifyOrderId
string

Response

201 - application/json

Order created

​
id
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

Available options:
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

Available options:
PENDING,
PAID,
FAILED,
REFUNDED,
CANCELLED
Example:

"PENDING"

​
companyId
string
required

ID da empresa

Example:

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

​
company
object
required
​
orderItems
object[]
required
​
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"

​
email
string

Email do cliente

Example:

"joao@email.com"

​
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

Available options:
RESIDENTIAL,
COMMERCIAL
Example:

"RESIDENTIAL"

​
paymentMethod
enum<string>

Método de pagamento

Available options:
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
​
sales
object
​
isShopifyOrder
boolean
​
shopifyOrderId
string
​
notes
string

Notas ou observações

Example:

"Observações sobre o pedido"

⌘I