Sales

List Sales

GEThttps://api.zydon.com.br/api/sales/sales

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Query parameters

Response

200404500

OK

Body

application/json

currentPageinteger (int32)

perPageinteger (int32)

totalinteger (int64)

itemsarray of ListSaleResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/sales', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "items": [
    {
      "id": "text",
      "company_id": "text",
      "external_id": "text",
      "partner_id": "text",
      "partner_name": "text",
      "total_value": 0,
      "items_quantity": 0,
      "origin_id": "text",
      "origin_name": "text",
      "created_at": "2024-12-21T14:36:22.826Z",
      "payments": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "status": {
        "id": "text",
        "status_id": "text",
        "title": "text",
        "background_color": "text",
        "font_color": "text"
      }
    }
  ]
}

Create a new sale

POSThttps://api.zydon.com.br/api/sales/sales

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Body

application/json

external_idstring

company_idstring

total_value*number

full_value*number

partner_id*string

seller_idstring

observationstring

invoicesarray of string

created_at*string (date-time)

updated_by*string

origin*CreateSaleOriginRequest (object)

items*array of CreateSaleItemRequest (object)

freightCreateFreightRequest (object)

discountarray of CreateSaleDiscountRequest (object)

paymentsarray of CreateSalePaymentRequest (object)

pre_order_complementobject

checkout_complementobject

automation_fieldsobject

resume_fieldsobject

deliveryCreateSaleDeliveryRequest (object)

Response

200400500

OK

Body

application/json

idstring

external_idstring

organization_idstring

company_idstring

total_valuenumber

full_valuenumber

partner_idstring

seller_idstring

created_atstring (date-time)

updated_bystring

total_discountnumber

invoicesarray of string

originCreateSaleOriginResponse (object)

itemsarray of CreateSaleItemResponse (object)

freightCreateFreightResponse (object)

discountarray of CreateSaleDiscountResponse (object)

paymentsarray of CreateSalePaymentResponse (object)

pre_order_complementobject

checkout_complementobject

automation_fieldsobject

deliveryCreateSaleDeliveryResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/sales', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "created_at": "2024-12-21T14:36:22.826Z",
      "full_value": 0,
      "items": [
        {}
      ],
      "origin": {
        "solution_id": "text"
      },
      "partner_id": "text",
      "total_value": 0,
      "updated_by": "text"
    }),
});
const data = await response.json();

Response

200400500

{
  "id": "text",
  "external_id": "text",
  "organization_id": "text",
  "company_id": "text",
  "total_value": 0,
  "full_value": 0,
  "partner_id": "text",
  "seller_id": "text",
  "created_at": "2024-12-21T14:36:22.826Z",
  "updated_by": "text",
  "total_discount": 0,
  "invoices": [
    "text"
  ],
  "origin": {
    "origin_id": "text"
  },
  "items": [
    {
      "id": "text",
      "product_id": "text",
      "product_name": "text",
      "quantity": 0,
      "unit": "text",
      "unit_value": 0,
      "discount": 0,
      "total_value": 0
    }
  ],
  "freight": {
    "id": "text",
    "amount": 0
  },
  "discount": [
    {
      "id": "text",
      "type": "text",
      "amount": 0
    }
  ],
  "payments": [
    {
      "id": "text",
      "payment_method_id": "text",
      "payment_method_name": "text",
      "payment_method_type": "text",
      "amount": 0,
      "installments": 0
    }
  ],
  "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"
  }
}

Get sale

GEThttps://api.zydon.com.br/api/sales/sales/{id}

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Path parameters

id*string

Response

200404500

OK

Body

application/json

idstring

organization_idstring

companyResumedCompanyResponse (object)

external_idstring

total_valuenumber

full_valuenumber

observationstring

partnerGetSalePartnerResponse (object)

sellerGetSaleSellerResponse (object)

invoicesarray of string

created_atstring (date-time)

updated_bystring

total_discountnumber

originGetSaleOriginResponse (object)

itemsarray of GetSaleItemResponse (object)

freightGetFreightResponse (object)

discountarray of GetSaleDiscountResponse (object)

paymentsarray of GetSalePaymentResponse (object)

pre_order_complementobject

checkout_complementobject

automation_fieldsobject

deliveryGetSaleDeliveryResponse (object)

statusesarray of GetSaleStatusResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/sales/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "id": "text",
  "organization_id": "text",
  "company": {
    "id": "text",
    "name": "text",
    "fiscal_registration_number": "text"
  },
  "external_id": "text",
  "total_value": 0,
  "full_value": 0,
  "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": "2024-12-21T14:36:22.826Z",
  "updated_by": "text",
  "total_discount": 0,
  "origin": {
    "id": "text",
    "name": "text"
  },
  "items": [
    {
      "id": "text",
      "product_id": "text",
      "product_name": "text",
      "quantity": 0,
      "unit": "text",
      "unit_value": 0,
      "discount": 0,
      "total_value": 0
    }
  ],
  "freight": {
    "id": "text",
    "amount": 0
  },
  "discount": [
    {
      "id": "text",
      "type": "text",
      "amount": 0
    }
  ],
  "payments": [
    {
      "id": "text",
      "payment_method_id": "text",
      "payment_method_name": "text",
      "payment_method_type": "text",
      "amount": 0,
      "installments": 0
    }
  ],
  "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": "2024-12-21T14:36:22.826Z"
    }
  ]
}