v2.0.0

Leads2b - API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Leads2b Public API V2

Contact

contato@leads2b.com

License

Proprietary

---

Order

Order management endpoints

Operations

GET/orders/{id}DELETE/orders/{id}PATCH/orders/{id}GET/ordersPOST/orders

---

Get Order by id

GET

/orders/{id}

Returns a single order by its id.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

id*

ID of the resource

Type

integer

Required

Responses

Successful operation

Content-Type

application/json

{

  

"data": {

  

  

"id": 0,

  

  

"date": "2026-04-13T17:17:50",

  

  

"fk_id": "string",

  

  

"status": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"freight": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"value": 0,

  

  

  

"fk_id": "string"

  

  

},

  

  

"customer": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"user": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"observations": "string",

  

  

"delivery_date": "2026-04-13T17:17:50",

  

  

"opportunity": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"quotation": {

  

  

  

"id": 0,

  

  

  

"name": "string"

  

  

},

  

  

"payment_type": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"payment_method": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"category": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"shipping_company": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"address": {

  

  

  

"id": 0,

  

  

  

"street": "string",

  

  

  

"number": 0,

  

  

  

"complement": "string",

  

  

  

"zip_code": 0,

  

  

  

"neighborhood": "string",

  

  

  

"city": "string",

  

  

  

"state": "string",

  

  

  

"latitude": 0,

  

  

  

"longitude": 0,

  

  

  

"address_type": "string",

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"branch_company": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"total_value": 0,

  

  

"items": [

  

  

  

{

  

  

  

  

"id": 0,

  

  

  

  

"item": {

  

  

  

  

  

"id": 0,

  

  

  

  

  

"name": "string",

  

  

  

  

  

"fk_id": "string",

  

  

  

  

  

"type": "string"

  

  

  

  

},

  

  

  

  

"quantity": 0,

  

  

  

  

"price": 0,

  

  

  

  

"description": "string",

  

  

  

  

"created_at": "2026-04-13T17:17:50",

  

  

  

  

"unit_liq": 0,

  

  

  

  

"perc_desc": 0,

  

  

  

  

"vlr_desc": 0,

  

  

  

  

"total_liq": 0,

  

  

  

  

"fk_id": "string",

  

  

  

  

"base_icms_st": 0,

  

  

  

  

"icms_st": 0,

  

  

  

  

"vlr_icms_st": 0,

  

  

  

  

"base_ipi": 0,

  

  

  

  

"ipi": 0,

  

  

  

  

"value_ipi": 0,

  

  

  

  

"base_icms": 0,

  

  

  

  

"icms": 0,

  

  

  

  

"vlr_icms": 0,

  

  

  

  

"recurrency_period": 0

  

  

  

}

  

  

],

  

  

"custom_fields": {

  

  

  

"additionalProperties": null

  

  

}

  

},

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

GET

/orders/{id}

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

---

Delete Order

DELETE

/orders/{id}

Deletes a order.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

id*

ID of the resource

Type

integer

Required

Responses

Resource deleted successfully

Content-Type

application/json

{

  

"success": true,

  

"message": "Deleted successfully",

  

"deletedId": 0,

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

DELETE

/orders/{id}

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

---

Update Order

PATCH

/orders/{id}

Updates an existing order.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

id*

ID of the resource

Type

integer

Required

Request Body

application/json

{

  

"date": "2026-04-13T17:17:49",

  

"id_customer": 0,

  

"id_user": 0,

  

"fk_id": "string",

  

"id_payment_type": 0,

  

"id_payment_method": 0,

  

"id_order_status": 0,

  

"id_category": 0,

  

"id_freight_type": 0,

  

"freight_value": 0,

  

"id_shipping_company": 0,

  

"id_address": 0,

  

"observations": "string",

  

"delivery_date": "2026-04-13T17:17:49",

  

"id_branch_company": 0,

  

"custom_fields": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Resource updated successfully

Content-Type

application/json

{

  

"data": {

  

  

"id": 0,

  

  

"date": "2026-04-13T17:17:50",

  

  

"fk_id": "string",

  

  

"status": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"freight": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"value": 0,

  

  

  

"fk_id": "string"

  

  

},

  

  

"customer": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"user": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"observations": "string",

  

  

"delivery_date": "2026-04-13T17:17:50",

  

  

"opportunity": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"quotation": {

  

  

  

"id": 0,

  

  

  

"name": "string"

  

  

},

  

  

"payment_type": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"payment_method": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"category": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"shipping_company": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"address": {

  

  

  

"id": 0,

  

  

  

"street": "string",

  

  

  

"number": 0,

  

  

  

"complement": "string",

  

  

  

"zip_code": 0,

  

  

  

"neighborhood": "string",

  

  

  

"city": "string",

  

  

  

"state": "string",

  

  

  

"latitude": 0,

  

  

  

"longitude": 0,

  

  

  

"address_type": "string",

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"branch_company": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"total_value": 0,

  

  

"items": [

  

  

  

{

  

  

  

  

"id": 0,

  

  

  

  

"item": {

  

  

  

  

  

"id": 0,

  

  

  

  

  

"name": "string",

  

  

  

  

  

"fk_id": "string",

  

  

  

  

  

"type": "string"

  

  

  

  

},

  

  

  

  

"quantity": 0,

  

  

  

  

"price": 0,

  

  

  

  

"description": "string",

  

  

  

  

"created_at": "2026-04-13T17:17:50",

  

  

  

  

"unit_liq": 0,

  

  

  

  

"perc_desc": 0,

  

  

  

  

"vlr_desc": 0,

  

  

  

  

"total_liq": 0,

  

  

  

  

"fk_id": "string",

  

  

  

  

"base_icms_st": 0,

  

  

  

  

"icms_st": 0,

  

  

  

  

"vlr_icms_st": 0,

  

  

  

  

"base_ipi": 0,

  

  

  

  

"ipi": 0,

  

  

  

  

"value_ipi": 0,

  

  

  

  

"base_icms": 0,

  

  

  

  

"icms": 0,

  

  

  

  

"vlr_icms": 0,

  

  

  

  

"recurrency_period": 0

  

  

  

}

  

  

],

  

  

"custom_fields": {

  

  

  

"additionalProperties": null

  

  

}

  

},

  

"message": "string",

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

PATCH

/orders/{id}

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Body

Samples

---

Search Orders

GET

/orders

Search and list orders with filtering, sorting, and pagination.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Query Parameters

fk_id

Type

string

create_date_from

Type

string

Example"2026-04-13T17:17:49"

Format

"date-time"

create_date_to

Type

string

Example"2026-04-13T17:17:49"

Format

"date-time"

update_date_from

Type

string

Example"2026-04-13T17:17:49"

Format

"date-time"

update_date_to

Type

string

Example"2026-04-13T17:17:49"

Format

"date-time"

order_date_from

Type

string

Example"2026-04-13T17:17:49"

Format

"date-time"

order_date_to

Type

string

Example"2026-04-13T17:17:49"

Format

"date-time"

id_customer

ID of the Customer

Type

integer

Minimum

1

id_quotation

ID of the Quotation

Type

integer

Minimum

1

limit

Type

integer

Minimum

1

Maximum

100

Default

25

page

Type

integer

Minimum

1

Default

1

sort

Type

string

Valid values

"id""created_at""updated_at""date""id_customer""-id""-created_at""-updated_at""-date""-id_customer"

Responses

Successful operation

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"id": 0,

  

  

  

"date": "2026-04-13T17:17:50",

  

  

  

"fk_id": "string",

  

  

  

"status": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string",

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"freight": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string",

  

  

  

  

"value": 0,

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"customer": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string",

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"user": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string",

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"observations": "string",

  

  

  

"delivery_date": "2026-04-13T17:17:50",

  

  

  

"opportunity": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string",

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"quotation": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string"

  

  

  

},

  

  

  

"payment_type": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string",

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"payment_method": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string",

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"category": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string",

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"shipping_company": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string",

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"address": {

  

  

  

  

"id": 0,

  

  

  

  

"street": "string",

  

  

  

  

"number": 0,

  

  

  

  

"complement": "string",

  

  

  

  

"zip_code": 0,

  

  

  

  

"neighborhood": "string",

  

  

  

  

"city": "string",

  

  

  

  

"state": "string",

  

  

  

  

"latitude": 0,

  

  

  

  

"longitude": 0,

  

  

  

  

"address_type": "string",

  

  

  

  

"name": "string",

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"branch_company": {

  

  

  

  

"id": 0,

  

  

  

  

"name": "string",

  

  

  

  

"fk_id": "string"

  

  

  

},

  

  

  

"total_value": 0,

  

  

  

"items": [

  

  

  

  

{

  

  

  

  

  

"id": 0,

  

  

  

  

  

"item": {

  

  

  

  

  

  

"id": 0,

  

  

  

  

  

  

"name": "string",

  

  

  

  

  

  

"fk_id": "string",

  

  

  

  

  

  

"type": "string"

  

  

  

  

  

},

  

  

  

  

  

"quantity": 0,

  

  

  

  

  

"price": 0,

  

  

  

  

  

"description": "string",

  

  

  

  

  

"created_at": "2026-04-13T17:17:50",

  

  

  

  

  

"unit_liq": 0,

  

  

  

  

  

"perc_desc": 0,

  

  

  

  

  

"vlr_desc": 0,

  

  

  

  

  

"total_liq": 0,

  

  

  

  

  

"fk_id": "string",

  

  

  

  

  

"base_icms_st": 0,

  

  

  

  

  

"icms_st": 0,

  

  

  

  

  

"vlr_icms_st": 0,

  

  

  

  

  

"base_ipi": 0,

  

  

  

  

  

"ipi": 0,

  

  

  

  

  

"value_ipi": 0,

  

  

  

  

  

"base_icms": 0,

  

  

  

  

  

"icms": 0,

  

  

  

  

  

"vlr_icms": 0,

  

  

  

  

  

"recurrency_period": 0

  

  

  

  

}

  

  

  

],

  

  

  

"custom_fields": {

  

  

  

  

"additionalProperties": null

  

  

  

}

  

  

}

  

],

  

"pagination": {

  

  

"page": 1,

  

  

"limit": 25,

  

  

"total": 100,

  

  

"totalPages": 4,

  

  

"hasNext": true,

  

  

"hasPrev": false,

  

  

"links": {

  

  

  

"self": "/orders?page=1&limit=25",

  

  

  

"first": "/orders?page=1&limit=25",

  

  

  

"last": "/orders?page=4&limit=25",

  

  

  

"next": "/orders?page=2&limit=25",

  

  

  

"prev": "string"

  

  

}

  

},

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

GET

/orders

Playground

Authorization

BearerAuth

Variables

Key

Value

fk_id

create_date_from

create_date_to

update_date_from

update_date_to

order_date_from

order_date_to

id_customer

id_quotation

limit

page

sort

Samples

---

Create Order

POST

/orders

Creates a new order.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Request Body

application/json

{

  

"date": "2026-04-13T17:17:49",

  

"id_customer": 0,

  

"id_user": 0,

  

"fk_id": "string",

  

"id_payment_type": 0,

  

"id_payment_method": 0,

  

"id_order_status": 0,

  

"id_category": 0,

  

"id_freight_type": 0,

  

"freight_value": 0,

  

"id_shipping_company": 0,

  

"id_address": 0,

  

"observations": "string",

  

"delivery_date": "2026-04-13T17:17:49",

  

"id_branch_company": 0,

  

"custom_fields": {

  

  

"additionalProperties": "string"

  

},

  

"items": [

  

  

{

  

  

  

"id_item": 0,

  

  

  

"quantity": 0,

  

  

  

"price": 0,

  

  

  

"total_item": 0,

  

  

  

"description": "string",

  

  

  

"discount_value": 0,

  

  

  

"discount_percentage": 0,

  

  

  

"net_unit_value": 0,

  

  

  

"net_value": 0,

  

  

  

"base_icms_st": 0,

  

  

  

"aliq_icms_st": 0,

  

  

  

"value_icms_st": 0,

  

  

  

"base_ipi": 0,

  

  

  

"aliq_ipi": 0,

  

  

  

"value_ipi": 0,

  

  

  

"base_icms": 0,

  

  

  

"aliq_icms": 0,

  

  

  

"value_icms": 0

  

  

}

  

]

}

Responses

Resource created successfully

Content-Type

application/json

{

  

"data": {

  

  

"id": 0,

  

  

"date": "2026-04-13T17:17:50",

  

  

"fk_id": "string",

  

  

"status": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"freight": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"value": 0,

  

  

  

"fk_id": "string"

  

  

},

  

  

"customer": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"user": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"observations": "string",

  

  

"delivery_date": "2026-04-13T17:17:50",

  

  

"opportunity": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"quotation": {

  

  

  

"id": 0,

  

  

  

"name": "string"

  

  

},

  

  

"payment_type": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"payment_method": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"category": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"shipping_company": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"address": {

  

  

  

"id": 0,

  

  

  

"street": "string",

  

  

  

"number": 0,

  

  

  

"complement": "string",

  

  

  

"zip_code": 0,

  

  

  

"neighborhood": "string",

  

  

  

"city": "string",

  

  

  

"state": "string",

  

  

  

"latitude": 0,

  

  

  

"longitude": 0,

  

  

  

"address_type": "string",

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"branch_company": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"total_value": 0,

  

  

"items": [

  

  

  

{

  

  

  

  

"id": 0,

  

  

  

  

"item": {

  

  

  

  

  

"id": 0,

  

  

  

  

  

"name": "string",

  

  

  

  

  

"fk_id": "string",

  

  

  

  

  

"type": "string"

  

  

  

  

},

  

  

  

  

"quantity": 0,

  

  

  

  

"price": 0,

  

  

  

  

"description": "string",

  

  

  

  

"created_at": "2026-04-13T17:17:50",

  

  

  

  

"unit_liq": 0,

  

  

  

  

"perc_desc": 0,

  

  

  

  

"vlr_desc": 0,

  

  

  

  

"total_liq": 0,

  

  

  

  

"fk_id": "string",

  

  

  

  

"base_icms_st": 0,

  

  

  

  

"icms_st": 0,

  

  

  

  

"vlr_icms_st": 0,

  

  

  

  

"base_ipi": 0,

  

  

  

  

"ipi": 0,

  

  

  

  

"value_ipi": 0,

  

  

  

  

"base_icms": 0,

  

  

  

  

"icms": 0,

  

  

  

  

"vlr_icms": 0,

  

  

  

  

"recurrency_period": 0

  

  

  

}

  

  

],

  

  

"custom_fields": {

  

  

  

"additionalProperties": null

  

  

}

  

},

  

"message": "string",

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

POST

/orders

Playground

Authorization

BearerAuth

Body

Samples

---

Order Item

Order Item management endpoints

Operations

DELETE/orders/{id_order}/items/{id}PATCH/orders/{id_order}/items/{id}POST/orders/{id_order}/items

---

Delete Order item

DELETE

/orders/{id_order}/items/{id}

Deletes a order item.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

id_order*

ID of the order

Type

integer

Required

id*

ID of the resource

Type

integer

Required

Responses

Resource deleted successfully

Content-Type

application/json

{

  

"success": true,

  

"message": "Deleted successfully",

  

"deletedId": 0,

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

DELETE

/orders/{id_order}/items/{id}

Playground

Authorization

BearerAuth

Variables

Key

Value

id_order*

id*

Samples

---

Update Order item

PATCH

/orders/{id_order}/items/{id}

Updates an existing order item.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

id_order*

ID of the order

Type

integer

Required

id*

ID of the resource

Type

integer

Required

Request Body

application/json

{

  

"id_item": 0,

  

"quantity": 0,

  

"price": 0,

  

"total_item": 0,

  

"description": "string",

  

"discount_value": 0,

  

"discount_percentage": 0,

  

"net_unit_value": 0,

  

"net_value": 0,

  

"base_icms_st": 0,

  

"aliq_icms_st": 0,

  

"value_icms_st": 0,

  

"base_ipi": 0,

  

"aliq_ipi": 0,

  

"value_ipi": 0,

  

"base_icms": 0,

  

"aliq_icms": 0,

  

"value_icms": 0

}

Responses

Resource updated successfully

Content-Type

application/json

{

  

"data": {

  

  

"id": 0,

  

  

"date": "2026-04-13T17:17:50",

  

  

"fk_id": "string",

  

  

"status": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"freight": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"value": 0,

  

  

  

"fk_id": "string"

  

  

},

  

  

"customer": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"user": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"observations": "string",

  

  

"delivery_date": "2026-04-13T17:17:50",

  

  

"opportunity": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"quotation": {

  

  

  

"id": 0,

  

  

  

"name": "string"

  

  

},

  

  

"payment_type": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"payment_method": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"category": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"shipping_company": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"address": {

  

  

  

"id": 0,

  

  

  

"street": "string",

  

  

  

"number": 0,

  

  

  

"complement": "string",

  

  

  

"zip_code": 0,

  

  

  

"neighborhood": "string",

  

  

  

"city": "string",

  

  

  

"state": "string",

  

  

  

"latitude": 0,

  

  

  

"longitude": 0,

  

  

  

"address_type": "string",

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"branch_company": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"total_value": 0,

  

  

"items": [

  

  

  

{

  

  

  

  

"id": 0,

  

  

  

  

"item": {

  

  

  

  

  

"id": 0,

  

  

  

  

  

"name": "string",

  

  

  

  

  

"fk_id": "string",

  

  

  

  

  

"type": "string"

  

  

  

  

},

  

  

  

  

"quantity": 0,

  

  

  

  

"price": 0,

  

  

  

  

"description": "string",

  

  

  

  

"created_at": "2026-04-13T17:17:50",

  

  

  

  

"unit_liq": 0,

  

  

  

  

"perc_desc": 0,

  

  

  

  

"vlr_desc": 0,

  

  

  

  

"total_liq": 0,

  

  

  

  

"fk_id": "string",

  

  

  

  

"base_icms_st": 0,

  

  

  

  

"icms_st": 0,

  

  

  

  

"vlr_icms_st": 0,

  

  

  

  

"base_ipi": 0,

  

  

  

  

"ipi": 0,

  

  

  

  

"value_ipi": 0,

  

  

  

  

"base_icms": 0,

  

  

  

  

"icms": 0,

  

  

  

  

"vlr_icms": 0,

  

  

  

  

"recurrency_period": 0

  

  

  

}

  

  

],

  

  

"custom_fields": {

  

  

  

"additionalProperties": null

  

  

}

  

},

  

"message": "string",

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

PATCH

/orders/{id_order}/items/{id}

Playground

Authorization

BearerAuth

Variables

Key

Value

id_order*

id*

Body

Samples

---

Create Order item

POST

/orders/{id_order}/items

Creates a new order item.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

id_order*

ID of the order

Type

integer

Required

Request Body

application/json

{

  

"id_item": 0,

  

"quantity": 0,

  

"price": 0,

  

"total_item": 0,

  

"description": "string",

  

"discount_value": 0,

  

"discount_percentage": 0,

  

"net_unit_value": 0,

  

"net_value": 0,

  

"base_icms_st": 0,

  

"aliq_icms_st": 0,

  

"value_icms_st": 0,

  

"base_ipi": 0,

  

"aliq_ipi": 0,

  

"value_ipi": 0,

  

"base_icms": 0,

  

"aliq_icms": 0,

  

"value_icms": 0

}

Responses

Resource created successfully

Content-Type

application/json

{

  

"data": {

  

  

"id": 0,

  

  

"date": "2026-04-13T17:17:50",

  

  

"fk_id": "string",

  

  

"status": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"freight": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"value": 0,

  

  

  

"fk_id": "string"

  

  

},

  

  

"customer": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"user": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"observations": "string",

  

  

"delivery_date": "2026-04-13T17:17:50",

  

  

"opportunity": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"quotation": {

  

  

  

"id": 0,

  

  

  

"name": "string"

  

  

},

  

  

"payment_type": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"payment_method": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"category": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"shipping_company": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"address": {

  

  

  

"id": 0,

  

  

  

"street": "string",

  

  

  

"number": 0,

  

  

  

"complement": "string",

  

  

  

"zip_code": 0,

  

  

  

"neighborhood": "string",

  

  

  

"city": "string",

  

  

  

"state": "string",

  

  

  

"latitude": 0,

  

  

  

"longitude": 0,

  

  

  

"address_type": "string",

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"branch_company": {

  

  

  

"id": 0,

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

},

  

  

"total_value": 0,

  

  

"items": [

  

  

  

{

  

  

  

  

"id": 0,

  

  

  

  

"item": {

  

  

  

  

  

"id": 0,

  

  

  

  

  

"name": "string",

  

  

  

  

  

"fk_id": "string",

  

  

  

  

  

"type": "string"

  

  

  

  

},

  

  

  

  

"quantity": 0,

  

  

  

  

"price": 0,

  

  

  

  

"description": "string",

  

  

  

  

"created_at": "2026-04-13T17:17:50",

  

  

  

  

"unit_liq": 0,

  

  

  

  

"perc_desc": 0,

  

  

  

  

"vlr_desc": 0,

  

  

  

  

"total_liq": 0,

  

  

  

  

"fk_id": "string",

  

  

  

  

"base_icms_st": 0,

  

  

  

  

"icms_st": 0,

  

  

  

  

"vlr_icms_st": 0,

  

  

  

  

"base_ipi": 0,

  

  

  

  

"ipi": 0,

  

  

  

  

"value_ipi": 0,

  

  

  

  

"base_icms": 0,

  

  

  

  

"icms": 0,

  

  

  

  

"vlr_icms": 0,

  

  

  

  

"recurrency_period": 0

  

  

  

}

  

  

],

  

  

"custom_fields": {

  

  

  

"additionalProperties": null

  

  

}

  

},

  

"message": "string",

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

POST

/orders/{id_order}/items

Playground

Authorization

BearerAuth

Variables

Key

Value

id_order*

Body

Samples

---

Customer Address

Customer Address management endpoints

Operations

GET/customers/{customerId}/addressPOST/customers/{customerId}/addressGET/customers/address/{id}DELETE/customers/address/{id}PATCH/customers/address/{id}

---

List Customer addresses

GET

/customers/{customerId}/address

Lists customer addresses.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

customerId*

External ID of the customerId

Type

string

Required

Query Parameters

limit

Type

number

Minimum

1

Maximum

100

offset

Type

number

Minimum

0

Responses

Successful operation

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"id": 0,

  

  

  

"street": "string",

  

  

  

"number": 0,

  

  

  

"complement": "string",

  

  

  

"zip_code": 0,

  

  

  

"neighborhood": "string",

  

  

  

"city": "string",

  

  

  

"state": "string",

  

  

  

"latitude": 0,

  

  

  

"longitude": 0,

  

  

  

"address_type": "string",

  

  

  

"name": "string",

  

  

  

"fk_id": "string"

  

  

}

  

],

  

"pagination": {

  

  

"page": 1,

  

  

"limit": 25,

  

  

"total": 100,

  

  

"totalPages": 4,

  

  

"hasNext": true,

  

  

"hasPrev": false,

  

  

"links": {

  

  

  

"self": "/orders?page=1&limit=25",

  

  

  

"first": "/orders?page=1&limit=25",

  

  

  

"last": "/orders?page=4&limit=25",

  

  

  

"next": "/orders?page=2&limit=25",

  

  

  

"prev": "string"

  

  

}

  

},

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

GET

/customers/{customerId}/address

Playground

Authorization

BearerAuth

Variables

Key

Value

customerId*

limit

offset

Samples

---

Create Customer address

POST

/customers/{customerId}/address

Creates a new customer address.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

customerId*

External ID of the customerId

Type

string

Required

Request Body

application/json

{

  

"street": "string",

  

"number": 0,

  

"complement": "string",

  

"zip_code": 0,

  

"neighborhood": "string",

  

"city": "string",

  

"state": "string",

  

"latitude": 0,

  

"longitude": 0,

  

"address_type": "string",

  

"name": "string",

  

"fk_id": "string"

}

Responses

Resource created successfully

Content-Type

application/json

{

  

"data": {

  

  

"id": 0,

  

  

"street": "string",

  

  

"number": 0,

  

  

"complement": "string",

  

  

"zip_code": 0,

  

  

"neighborhood": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"latitude": 0,

  

  

"longitude": 0,

  

  

"address_type": "string",

  

  

"name": "string",

  

  

"fk_id": "string"

  

},

  

"message": "string",

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

POST

/customers/{customerId}/address

Playground

Authorization

BearerAuth

Variables

Key

Value

customerId*

Body

Samples

---

Get Customer address by id

GET

/customers/address/{id}

Returns a single customer address by its id.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

id*

ID of the resource

Type

integer

Required

Responses

Successful operation

Content-Type

application/json

{

  

"data": {

  

  

"id": 0,

  

  

"street": "string",

  

  

"number": 0,

  

  

"complement": "string",

  

  

"zip_code": 0,

  

  

"neighborhood": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"latitude": 0,

  

  

"longitude": 0,

  

  

"address_type": "string",

  

  

"name": "string",

  

  

"fk_id": "string"

  

},

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

GET

/customers/address/{id}

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

---

Delete Customer address

DELETE

/customers/address/{id}

Deletes a customer address.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

id*

ID of the resource

Type

integer

Required

Responses

Resource deleted successfully

Content-Type

application/json

{

  

"success": true,

  

"message": "Deleted successfully",

  

"deletedId": 0,

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

DELETE

/customers/address/{id}

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

---

Update Customer address

PATCH

/customers/address/{id}

Updates an existing customer address.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

id*

ID of the resource

Type

integer

Required

Request Body

application/json

{

  

"street": "string",

  

"number": 0,

  

"complement": "string",

  

"zip_code": 0,

  

"neighborhood": "string",

  

"city": "string",

  

"state": "string",

  

"latitude": 0,

  

"longitude": 0,

  

"address_type": "string",

  

"name": "string",

  

"fk_id": "string"

}

Responses

Resource updated successfully

Content-Type

application/json

{

  

"data": {

  

  

"id": 0,

  

  

"street": "string",

  

  

"number": 0,

  

  

"complement": "string",

  

  

"zip_code": 0,

  

  

"neighborhood": "string",

  

  

"city": "string",

  

  

"state": "string",

  

  

"latitude": 0,

  

  

"longitude": 0,

  

  

"address_type": "string",

  

  

"name": "string",

  

  

"fk_id": "string"

  

},

  

"message": "string",

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

PATCH

/customers/address/{id}

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Body

Samples

---

Product

Product management endpoints

Operations

POST/products/{id}/image

---

UploadImage Product

POST

/products/{id}/image

UploadImage product.

Authorizations

BearerAuth

Type

HTTP (bearer)

Example"Bearer ..."

Parameters

Path Parameters

id*

ID of the resource

Type

integer

Required

Request Body

multipart/form-data

object

The file to upload.

Format"binary"

Responses

Successful operation

Content-Type

application/json

{

  

"data": {

  

  

"message": "string",

  

  

"fileName": "string"

  

},

  

"meta": {

  

  

"timestamp": "2026-04-13T17:17:49",

  

  

"version": "1.0.0"

  

}

}

POST

/products/{id}/image

Playground

Authorization

BearerAuth

Variables

Key

Value

id*

Body

Samples

---