⚡
Zydon
Uptime serviços Zydon
  • Bem-vindo à Zydon
  • Quickstart
    • Chaves de acesso
    • Autenticação
  • Cadastros Gerais
    • Profiles
      • Import
      • Get import spreadsheet
    • Sellers
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Partners
    • Companies
      • Import
      • Get import spreadsheet
    • Resource files
      • Details
    • Partners
      • Sellers
        • Import
        • Get import spreadsheet
      • Contact
      • Address
        • Import
        • Get import spreadsheet
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
      • Analysis
  • Produtos
    • Products
      • Variations
        • Import
        • Get import spreadsheet
      • Specification
        • Import
        • Get import spreadsheet
      • Images
      • Enable
      • Disable
      • Alternative units
        • Import
        • Get import spreadsheet
      • Search
        • Synchronize
        • Status
      • Main images
      • Import
      • Get import spreadsheet
      • Generate sku code
      • Similar
      • Recommended
      • Image
      • Analysis
        • Most sold
        • Highlight
    • Prices
      • Product
        • Calculate
    • Stock
      • Enable
      • Disable
      • Override
      • Movement
      • Query
    • Discounts
      • Products
    • Price tables
      • Copy
      • Products
    • Warehouses
      • Import
      • Get import spreadsheet
    • Brands
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Image
    • Categories
      • Order
      • Enable
      • Disable
      • Specification
        • Import
        • Get import spreadsheet
      • Import
      • Get import spreadsheet
      • Image
      • Has products
      • Tree
    • Variations
      • Values
      • Import
      • Get import spreadsheet
    • Measure units
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Description
    • Portal User Search
      • User
        • Search
  • Pedidos
    • Payment groups
    • Orders
      • Items
        • Import
        • Get import spreadsheet
      • Payments
        • Import
        • Get import spreadsheet
      • Joint
      • Attachments
      • Report
      • Invoices
      • Import
      • Get import spreadsheet
      • Status
      • Summary
    • Payment methods
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
    • Status
    • Coupons
      • Manual
      • Automatic
    • Sales
      • Statuses
        • Available
  • Financeiro
    • Financials
      • Attachments
      • Import
      • Get import spreadsheet
      • Order
  • Webhooks
    • Sincronização de dados
    • Envio de Pedido
    • Cadastro de Parceiro
  • About
  • API reference
    • Warehouses
      • Import
      • Get import spreadsheet
    • Variations
      • Values
      • Import
      • Get import spreadsheet
    • Status
    • Sellers
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Partners
    • Profiles
      • Import
      • Get import spreadsheet
    • Products
      • Variations
        • Import
        • Get import spreadsheet
      • Specification
        • Import
        • Get import spreadsheet
      • Images
      • Enable
      • Disable
      • Alternative units
        • Import
        • Get import spreadsheet
      • Search
        • Synchronize
        • Status
      • Main images
      • Import
      • Get import spreadsheet
      • Generate sku code
      • Similar
      • Recommended
      • Image
      • Analysis
        • Most sold
        • Highlight
    • Price tables
      • Copy
      • Products
    • Payment methods
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
    • Payment groups
    • Partners
      • Sellers
        • Import
        • Get import spreadsheet
      • Contact
      • Address
        • Import
        • Get import spreadsheet
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
      • Analysis
    • Orders
      • Items
        • Import
        • Get import spreadsheet
      • Payments
        • Import
        • Get import spreadsheet
      • Joint
      • Attachments
      • Report
      • Invoices
      • Import
      • Get import spreadsheet
      • Status
      • Summary
    • Measure units
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Description
    • Financials
      • Attachments
      • Import
      • Get import spreadsheet
      • Order
    • Discounts
      • Products
    • Coupons
      • Manual
      • Automatic
    • Companies
      • Import
      • Get import spreadsheet
    • Categories
      • Order
      • Enable
      • Disable
      • Specification
        • Import
        • Get import spreadsheet
      • Import
      • Get import spreadsheet
      • Image
      • Has products
      • Tree
    • Brands
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Image
    • Sales
      • Statuses
        • Available
    • Resource files
      • Details
    • Stock
      • Enable
      • Disable
      • Override
      • Movement
      • Query
    • Sales funnel
    • Template
      • Validate
      • Install
      • Export
    • Home
      • Sales
      • Sales by period
      • Products
      • Users
    • Prices
      • Product
        • Calculate
  • Specification
  • About
  • Specification
Fornecido por GitBook
Nesta página
  1. Pedidos

Sales

Get sale

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
application/json
404
Sales was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/sales/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "organization_id": "text",
  "company": {
    "id": "text",
    "name": "text",
    "fiscal_registration_number": "text"
  },
  "external_id": "text",
  "total_value": 1,
  "full_value": 1,
  "observation": "text",
  "partner": {
    "id": "text",
    "name": "text",
    "phone": "text",
    "mobile": "text",
    "fiscal_registration_number": "text",
    "email": "text"
  },
  "seller": {
    "id": "text",
    "name": "text"
  },
  "invoices": [
    "text"
  ],
  "created_at": "2025-05-18T09:09:26.050Z",
  "updated_by": "text",
  "total_discount": 1,
  "origin": {
    "id": "text",
    "name": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "items": [
    {
      "id": "text",
      "product_id": "text",
      "product_name": "text",
      "quantity": 1,
      "unit": "text",
      "unit_value": 1,
      "discount": 1,
      "total_value": 1,
      "product_variation_id": "text"
    }
  ],
  "freight": {
    "id": "text",
    "amount": 1
  },
  "discount": [
    {
      "id": "text",
      "type": "text",
      "amount": 1
    }
  ],
  "payments": [
    {
      "id": "text",
      "payment_method_id": "text",
      "payment_method_name": "text",
      "payment_method_type": "text",
      "amount": 1,
      "installments": 1
    }
  ],
  "pre_order_complement": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "checkout_complement": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "automation_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "delivery": {
    "address_type": "text",
    "street": "text",
    "number": "text",
    "complement": "text",
    "neighborhood": "text",
    "state": "text",
    "postal_code": "text",
    "country": "text",
    "contact_name": "text",
    "contact_number": "text"
  },
  "statuses": [
    {
      "id": "text",
      "status_id": "text",
      "created_at": "2025-05-18T09:09:26.050Z"
    }
  ]
}
  • GETList Sales
  • POSTCreate a new sale
  • GETGet sale

List Sales

get
Autorizações
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: id
dirstringOpcionalDefault: asc
partner_idstringOpcional
start_datestring · date-timeOpcional
final_datestring · date-timeOpcional
Respostas
200
OK
application/json
404
Sales was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/sales HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "company_id": "text",
      "external_id": "text",
      "partner_id": "text",
      "partner_name": "text",
      "total_value": 1,
      "items_quantity": 1,
      "origin_id": "text",
      "origin_name": "text",
      "origin": {
        "id": "text",
        "name": "text",
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "created_at": "2025-05-18T09:09:26.050Z",
      "payments": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "status": {
        "id": "text",
        "status_id": "text",
        "title": "text",
        "background_color": "text",
        "font_color": "text"
      }
    }
  ]
}

Create a new sale

post
Autorizações
Corpo
external_idstringOpcional
company_idstringOpcional
total_valuenumberObrigatório
full_valuenumberObrigatório
partner_idstringObrigatório
seller_idstringOpcional
observationstringOpcional
invoicesstring[]Opcional
created_atstring · date-timeObrigatório
updated_bystringObrigatório
shopping_cart_idstringOpcional
Respostas
200
OK
application/json
400
Cannot create sale
application/json
500
An internal server error was thrown
application/json
post
POST /api/sales/sales HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1182

{
  "external_id": "text",
  "company_id": "text",
  "total_value": 1,
  "full_value": 1,
  "partner_id": "text",
  "seller_id": "text",
  "observation": "text",
  "invoices": [
    "text"
  ],
  "created_at": "2025-05-18T09:09:26.050Z",
  "updated_by": "text",
  "origin": {
    "solution_id": "text",
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "items": [
    {
      "product_id": "text",
      "quantity": 1,
      "unit": "text",
      "unit_value": 1,
      "discount": 1,
      "total_value": 1,
      "product_variation_id": "text",
      "automation_fields": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "freight": {
    "amount": 1
  },
  "discount": [
    {
      "type": "text",
      "amount": 1
    }
  ],
  "payments": [
    {
      "payment_method_id": "text",
      "amount": 1,
      "installments": 1,
      "transaction_id": "text"
    }
  ],
  "pre_order_complement": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "checkout_complement": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "automation_fields": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "resume_fields": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "delivery": {
    "id": "text",
    "address_type": "text",
    "street": "text",
    "number": "text",
    "complement": "text",
    "neighborhood": "text",
    "city": "text",
    "state": "text",
    "postal_code": "text",
    "country": "text",
    "contact_name": "text",
    "contact_number": "text"
  },
  "coupons": [
    {
      "coupon_id": "text"
    }
  ],
  "email_config": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "shopping_cart_id": "text"
}
{
  "id": "text",
  "external_id": "text",
  "organization_id": "text",
  "company_id": "text",
  "total_value": 1,
  "full_value": 1,
  "partner_id": "text",
  "seller_id": "text",
  "created_at": "2025-05-18T09:09:26.050Z",
  "updated_by": "text",
  "total_discount": 1,
  "invoices": [
    "text"
  ],
  "origin": {
    "origin_id": "text",
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "items": [
    {
      "id": "text",
      "product_id": "text",
      "product_name": "text",
      "quantity": 1,
      "unit": "text",
      "unit_value": 1,
      "discount": 1,
      "total_value": 1,
      "product_variation_id": "text"
    }
  ],
  "freight": {
    "id": "text",
    "amount": 1
  },
  "discount": [
    {
      "id": "text",
      "type": "text",
      "amount": 1
    }
  ],
  "payments": [
    {
      "id": "text",
      "payment_method_id": "text",
      "payment_method_name": "text",
      "payment_method_type": "text",
      "amount": 1,
      "installments": 1
    }
  ],
  "pre_order_complement": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "checkout_complement": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "automation_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "delivery": {
    "address_type": "text",
    "street": "text",
    "number": "text",
    "complement": "text",
    "neighborhood": "text",
    "city": "text",
    "state": "text",
    "postal_code": "text",
    "country": "text",
    "contact_name": "text",
    "contact_number": "text"
  }
}