Orders
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
application/json
404
Order was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/orders/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
"id": "text",
"origin": "text",
"company": {
"id": "text",
"name": "text",
"fiscal_registration_number": "text"
},
"partner_id": "text",
"negotiation_date": "text",
"seller_id": "text",
"total_value": 1,
"order_value": 1,
"discount_value": 1,
"shipment_address_name": "text",
"shipment_address_type": "text",
"shipment_street": "text",
"shipment_number": "text",
"shipment_complement": "text",
"shipment_neighborhood": "text",
"shipment_state": "text",
"shipment_postal_code": "text",
"shipment_country": "text",
"shipment_contact_name": "text",
"shipment_contact_number": "text",
"attachments": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"type": "text"
}
],
"invoices": [
{
"invoice_key": "text",
"xml_resource_id": "123e4567-e89b-12d3-a456-426614174000",
"xml_file_name": "text",
"xml_file_type": "text",
"danfe_resource_id": "123e4567-e89b-12d3-a456-426614174000",
"danfe_file_name": "text",
"danfe_file_type": "text"
}
],
"attributes": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"items": [
{
"id": {
"value": "text"
},
"orderId": {
"value": "text"
},
"productId": {
"value": "text"
},
"unitValue": 1,
"quantity": 1,
"unit": {
"value": "text"
},
"discount": 1,
"productVariationId": {
"value": "text"
}
}
],
"payments": [
{
"id": {
"value": "text"
},
"orderId": {
"value": "text"
},
"paymentMethodId": {
"value": "text"
},
"amount": 1,
"installments": 1
}
],
"statuses": [
{
"status_id": "text",
"created_at": "2025-07-03T09:04:32.958Z"
}
]
}
Autorizações
Parâmetros de rota
idstringObrigatório
Corpo
originstringObrigatório
company_idstringOpcional
partner_idstringObrigatório
negotiation_datestring · date-timeObrigatório
seller_idstringObrigatório
total_valuenumberObrigatório
order_valuenumberObrigatório
discount_valuenumberObrigatório
shipment_address_namestringOpcional
shipment_address_typestringOpcional
shipment_streetstringOpcional
shipment_numberstringOpcional
shipment_complementstringOpcional
shipment_neighborhoodstringOpcional
shipment_statestringOpcional
shipment_postal_codestringOpcional
shipment_countrystringOpcional
shipment_contact_namestringOpcional
shipment_contact_numberstringOpcional
statusstringOpcional
observationstringOpcional
attachmentsstring · uuid[]Opcional
Respostas
200
Order updated successfully
application/json
422
A validation error was thrown
500
An internal server error was thrown
put
PUT /api/sales/orders/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 944
{
"origin": "text",
"company_id": "text",
"partner_id": "text",
"negotiation_date": "2025-07-03T09:04:32.958Z",
"seller_id": "text",
"total_value": 1,
"order_value": 1,
"discount_value": 1,
"shipment_address_name": "text",
"shipment_address_type": "text",
"shipment_street": "text",
"shipment_number": "text",
"shipment_complement": "text",
"shipment_neighborhood": "text",
"shipment_state": "text",
"shipment_postal_code": "text",
"shipment_country": "text",
"shipment_contact_name": "text",
"shipment_contact_number": "text",
"status": "text",
"observation": "text",
"attachments": [
"123e4567-e89b-12d3-a456-426614174000"
],
"invoices": [
{
"invoice_key": "text",
"xml_resource_id": "123e4567-e89b-12d3-a456-426614174000",
"danfe_resource_id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"items": [
{
"id": "text",
"product_id": "text",
"unit_value": 1,
"quantity": 1,
"unit": "text",
"discount": 1,
"product_variation_id": "text"
}
],
"payments": [
{
"id": "text",
"payment_method_id": "text",
"amount": 1,
"installments": 1
}
]
}
{
"id": "text",
"origin": "text",
"company_id": "text",
"partner_id": "text",
"negotiation_date": "text",
"seller_id": "text",
"total_value": 1,
"order_value": 1,
"discount_value": 1,
"shipment_address_name": "text",
"shipment_address_type": "text",
"shipment_street": "text",
"shipment_number": "text",
"shipment_complement": "text",
"shipment_neighborhood": "text",
"shipment_state": "text",
"shipment_postal_code": "text",
"shipment_country": "text",
"shipment_contact_name": "text",
"shipment_contact_number": "text",
"attachments": [
"123e4567-e89b-12d3-a456-426614174000"
],
"invoices": [
{
"invoice_key": "text",
"xml_resource_id": "123e4567-e89b-12d3-a456-426614174000",
"danfe_resource_id": "123e4567-e89b-12d3-a456-426614174000"
}
]
}
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
204
Order removed successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
delete
DELETE /api/sales/orders/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
"id": "text"
}
Autorizações
Parâmetros de consulta
searchstringOpcionalDefault:
""
pageinteger · int32OpcionalDefault:
0
perPageinteger · int32OpcionalDefault:
25
sortstringOpcionalDefault:
""
dirstringOpcionalDefault:
asc
partner_idstringOpcional
start_datestring · dateOpcional
end_datestring · dateOpcional
Respostas
200
OK
application/json
404
Order was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/orders HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
"currentPage": 1,
"perPage": 1,
"total": 1,
"items": [
{
"id": "text",
"origin": "text",
"company_id": "text",
"partner_id": "text",
"negotiation_date": "text",
"seller_id": "text",
"status": "text",
"total_value": 1,
"order_value": 1,
"discount_value": 1,
"shipment_address_name": "text",
"shipment_address_type": "text",
"shipment_street": "text",
"shipment_number": "text",
"shipment_complement": "text",
"shipment_neighborhood": "text",
"shipment_state": "text",
"shipment_postal_code": "text",
"shipment_country": "text",
"shipment_contact_name": "text",
"shipment_contact_number": "text"
}
]
}
Autorizações
Corpo
idstringOpcional
originstringObrigatório
company_idstringOpcional
partner_idstringObrigatório
negotiation_datestring · date-timeObrigatório
seller_idstringObrigatório
total_valuenumberObrigatório
order_valuenumberObrigatório
discount_valuenumberObrigatório
shipment_address_namestringObrigatório
shipment_address_typestringObrigatório
shipment_streetstringObrigatório
shipment_numberstringObrigatório
shipment_complementstringObrigatório
shipment_neighborhoodstringObrigatório
shipment_statestringObrigatório
shipment_postal_codestringObrigatório
shipment_countrystringObrigatório
shipment_contact_namestringObrigatório
shipment_contact_numberstringObrigatório
statusstringOpcional
observationstringOpcional
attachmentsstring · uuid[]Opcional
Respostas
201
Order created successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
post
POST /api/sales/orders HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 745
{
"id": "text",
"origin": "text",
"company_id": "text",
"partner_id": "text",
"negotiation_date": "2025-07-03T09:04:32.958Z",
"seller_id": "text",
"total_value": 1,
"order_value": 1,
"discount_value": 1,
"shipment_address_name": "text",
"shipment_address_type": "text",
"shipment_street": "text",
"shipment_number": "text",
"shipment_complement": "text",
"shipment_neighborhood": "text",
"shipment_state": "text",
"shipment_postal_code": "text",
"shipment_country": "text",
"shipment_contact_name": "text",
"shipment_contact_number": "text",
"status": "text",
"observation": "text",
"attachments": [
"123e4567-e89b-12d3-a456-426614174000"
],
"invoices": [
{
"invoice_key": "text",
"xml_resource_id": "123e4567-e89b-12d3-a456-426614174000",
"danfe_resource_id": "123e4567-e89b-12d3-a456-426614174000"
}
]
}
{
"id": "text",
"origin": "text",
"company_id": "text",
"partner_id": "text",
"negotiation_date": "text",
"seller_id": "text",
"total_value": 1,
"order_value": 1,
"discount_value": 1,
"shipment_address_name": "text",
"shipment_address_type": "text",
"shipment_street": "text",
"shipment_number": "text",
"shipment_complement": "text",
"shipment_neighborhood": "text",
"shipment_state": "text",
"shipment_postal_code": "text",
"shipment_country": "text",
"shipment_contact_name": "text",
"shipment_contact_number": "text",
"attachments": [
"123e4567-e89b-12d3-a456-426614174000"
],
"invoices": [
{
"invoice_key": "text",
"xml_resource_id": "123e4567-e89b-12d3-a456-426614174000",
"danfe_resource_id": "123e4567-e89b-12d3-a456-426614174000"
}
]
}