> For the complete documentation index, see [llms.txt](https://expedy.gitbook.io/openapi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://expedy.gitbook.io/openapi/order.md). # Order **Considerações sobre os status internos da Expedy** **Valores aceitos:** **naocorrelacionado = produtos do pedido não tem correlação com a base da Expedy;** **aprovado = o pedido tem correlação e está pronto para ser faturado/expedido;** **pendente = o pedido está correlacionado aguardando a aprovação do cliente;** **faturado = o pedido foi faturado mas não teve a etiqueta liberada pelo marketplace;** **cancelado = pedido foi cancelado pelo comprador;** **emseparacao = pedido está faturado e com a etiqueta do marketplace liberada, ele está na expedição aguardando a conferência;** **temmensagem = para pedidos que o marketplace tem alguma interação de chat com o comprador (geralmente Mercado Livre), onde o comprador passa informações especificas para o vendedor, nesse status o pedido não é faturado nem é preparada a etiqueta.** **expedir = o pedido está faturado e com a etiqueta liberada pelo marketplace, assim ele está pronto para ir para a expedição** **completo = o pedido é considerado completo quando já passou pelo processo da expedição, onde foi imprimido a nota fiscal e a etiqueta de envio** ## Get Orders `GET` `/v1/order/` Endpoint para consulta de todos os pedidos. #### Query Parameters | Name | Type | Description | | -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | number | Id do pedido. | | orderid | string | Id do pedido **no Marketplace.** | | status | string |

Status do pedido na Expedy. Valores aceitos:

naocorrelacionado = produtos do pedido não tem correlação com a base da Expedy;

aprovado = o pedido tem correlação e está pronto para ser faturado/expedido;

pendente = o pedido está correlacionado aguardando a aprovação do cliente;

faturado = o pedido foi faturado mas não teve a etiqueta liberada pelo marketplace;

cancelado = pedido foi cancelado pelo comprador;

emseparacao = pedido está faturado e com a etiqueta do marketplace liberada, ele está na expedição aguardando a conferência;

temmensagem = para pedidos que o marketplace tem alguma interação de chat com o comprador (geralmente Mercado Livre), onde o comprador passa informações especificas para o vendedor, nesse status o pedido não é faturado nem é preparada a etiqueta.

| | status\_mp | string | Status do Marketplace. | | pageSize | number | Quantidade de itens por página. **Default: 10.** | | page | number | Número da página. **Default: 1.** | | modified\_from | string | Alterado a partir de. **Formato da data: Unix.** | | modified\_to | string | Alterado até. **Formato da data: Unix.** | | integracao | string | Tipo da Integração. **Ex: mercadolivre.** | | cliente\_cpf | string | CPF do cliente. | | cliente\_nome | string | Nome do cliente. | #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------------- | | Authorization\* | string | Access token para autenticação. | | Content-Type\* | string | application/json | {% tabs %} {% tab title="200 Exemplo de Response" %} ``` { "paging": { "total": 2, "page": 1, "limit": 10, "offset": 0 }, "Orders": [ { "id": 1, "integracao": { "id": "1", "name": "Hubmax ml", "tipo": "mercadolivre" }, "Customer": { "id": "1", "name": "Teste", "cpf": "11111111111", "cnpj": "11111111111111", "email": "teste@mail.mercadolivre.com", "type": "0", "CustomerAddresses": [ { "_id": "61603c4c6c914637d0232dff", "id": "111", "customer_id": "1", "address": "Rua Itarantim", "number": "695", "complement": "", "neighborhood": "Novo Aleixo", "city": "Manaus", "state": "AM", "zip_code": "69098212", "country": "Brasil", "type": "0", "description": "", "recipient": "Teste" } ] }, "Mensagens": [], "_id": "61603c4c6c914637d0232dfe", "company": "1", "status": "pendente", "status_mp": "paid", "point_sale": "Mercado Livre", "shipment": "Expresso", "shipment_value": 0, "orderid": "1", "pack_id": "11111111", "partial_total": 132, "fullfillment": false, "installment": 1, "total": 132, "ProductsSold": [ { "_id": "61603c4c6c914637d0232e00", "id": "1", "order_id": "1", "reference": "1111", "original_name": "Produto Teste", "price": 132, "quantity": 1, "product_id": "111", "variant_id": "222", // quando o produto vendido for um kit sua composicao irá aparecer assim "composicaoKit": [ { "stock": 0, "productId": "333", "name": "Azul Bebê", "quantity": 4, "porcentagemValor": 100, "price": 9.42 } ] } ], "Payment": [ { "_id": "61603c4c6c914637d0232e01", "date": "2021-07-07", "id": "1", "method": "money", "value": "132", "installment": 1 } ], "log": [], "createdAt": "2021-10-08T12:40:44.782Z", "updatedAt": "2021-10-08T12:40:44.782Z", "idERP_Order": 1, "__v": 0 }, { "id": 2, "integracao": { "id": "1", "name": "Hubmax ml", "tipo": "mercadolivre" }, "Customer": { "id": "1", "name": "Teste", "cpf": "11111111111", "cnpj": "11111111111111", "email": "teste@mail.mercadolivre.com", "type": "0", "CustomerAddresses": [ { "_id": "61603c6d6c914637d0232e05", "id": "111", "customer_id": "1", "address": "Rua Itarantim", "number": "695", "complement": "", "neighborhood": "Novo Aleixo", "city": "Manaus", "state": "AM", "zip_code": "69098212", "country": "Brasil", "type": "0", "description": "", "recipient": "Teste" } ] }, "Mensagens": [], "_id": "61603c6d6c914637d0232e04", "company": "1", "status": "pendente", "status_mp": "paid", "point_sale": "Mercado Livre", "shipment": "Expresso", "shipment_value": 0, "orderid": "2", "pack_id": "11111111", "partial_total": 132, "fullfillment": false, "installment": 1, "total": 132, "ProductsSold": [ { "_id": "61603c6d6c914637d0232e06", "id": "1", "order_id": "2", "reference": "1111", "original_name": "Produto Teste", "price": 132, "quantity": 1, "product_id": "111", "variant_id": "222" } ], "Payment": [ { "_id": "61603c6d6c914637d0232e07", "date": "2021-07-07", "id": "1", "method": "money", "value": "132", "installment": 1 } ], "log": [], "createdAt": "2021-10-08T12:41:17.133Z", "updatedAt": "2021-10-08T12:41:17.133Z", "idERP_Order": 2, "__v": 0 } ] } ``` {% endtab %} {% endtabs %} Todos os parâmetros são opcionais, podendo serem usados para aprimoramento da pesquisa. ``` ## Exemplo de Query ## { "id": "number", "orderid": "string", "status": "string", "status_mp": "string", "pageSize": "number", "page": "number", "modified_from": "string", "modified_to": "string", "integracao": "string", "cliente_cpf": "string", "cliente_nome": "string" } ``` ## Get Order by ID `GET` `/v1/order/:id` Endpoint para consulta de um pedido específico. #### Query Parameters | Name | Type | Description | | ------------------------------------ | ------ | ------------- | | id\* | string | Id do pedido. | #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------------- | | Authorization\* | string | Access token para autenticação. | | Content-Type\* | string | application/json | {% tabs %} {% tab title="200 Exemplo de Response." %} ``` { "order": { "id": 1, "integracao": { "id": "1", "name": "Hubmax ml", "tipo": "mercadolivre" }, "Customer": { "id": "1", "name": "Teste", "cpf": "11111111111", "cnpj": "11111111111111", "email": "teste@mail.mercadolivre.com", "type": "0", "CustomerAddresses": [ { "_id": "61603c4c6c914637d0232dff", "id": "111", "customer_id": "1", "address": "Rua Itarantim", "number": "695", "complement": "", "neighborhood": "Novo Aleixo", "city": "Manaus", "state": "AM", "zip_code": "69098212", "country": "Brasil", "type": "0", "description": "", "recipient": "Teste" } ] }, "Mensagens": [], "_id": "61603c4c6c914637d0232dfe", "company": "1", "status": "pendente", "status_mp": "paid", "point_sale": "Mercado Livre", "shipment": "Expresso", "shipment_value": 0, "orderid": "1", "pack_id": "11111111", "partial_total": 132, "fullfillment": false, "installment": 1, "total": 132, "ProductsSold": [ { "_id": "61603c4c6c914637d0232e00", "id": "1", "order_id": "1", "reference": "1111", "original_name": "Produto Teste", "price": 132, "quantity": 1, "product_id": "111", "variant_id": "222", // quando o produto vendido for um kit sua composicao irá aparecer assim "composicaoKit": [ { "stock": 0, "productId": "333", "name": "Azul Bebê", "quantity": 4, "porcentagemValor": 100, "price": 9.42 } ] } ], "Payment": [ { "_id": "61603c4c6c914637d0232e01", "date": "2021-07-07", "id": "1", "method": "money", "value": "132", "installment": 1 } ], "log": [], "createdAt": "2021-10-08T12:40:44.782Z", "updatedAt": "2021-10-08T12:40:44.782Z", "idERP_Order": 1, "__v": 0 } } ``` {% endtab %} {% tab title="400 Exemplo de response de pedido não encontrado." %} ``` { "message": "Pedido nao encontrado" } ``` {% endtab %} {% endtabs %} Para a consulta do pedido, é necessário mandar o id, deixando a url como **`/v1/order/7`** por exemplo. ## Put Order `PUT` `/v1/order/:id` Endpoint para atualização de um pedido específico. #### Query Parameters | Name | Type | Description | | ------------------------------------ | ------ | ------------- | | id\* | string | Id do Pedido. | #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ------------------------------- | | Authorization\* | string | Access token para autenticação. | | Content-Type\* | string | application/json | #### Request Body | Name | Type | Description | | ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------ | | status | string | Status do pedido. **Valores aceitos:** **aprovado, faturado e cancelado.** | | status\_hub | string | **Somente aceito no ambiente de testes.** Status interno do pedido na expedy. Valores aceitos estão no início da página. | {% tabs %} {% tab title="200 Exemplo de Response" %} ``` { "order": { "integracao": { "id": "1", "name": "Hubmax ml", "tipo": "mercadolivre" }, "Customer": { "id": "1", "name": "Teste", "cpf": "11111111111", "cnpj": "11111111111111", "email": "teste@mail.mercadolivre.com", "type": "0", "CustomerAddresses": [ { "_id": "61603c4c6c914637d0232dff", "id": "111", "customer_id": "1", "address": "Rua Itarantim", "number": "695", "complement": "", "neighborhood": "Novo Aleixo", "city": "Manaus", "state": "AM", "zip_code": "69098212", "country": "Brasil", "type": "0", "description": "", "recipient": "Teste" } ] }, "Mensagens": [], "_id": "61603c4c6c914637d0232dfe", "company": "1", "status": "aprovado", "status_mp": "paid", "point_sale": "Mercado Livre", "shipment": "Expresso", "shipment_value": 0, "orderid": "1", "pack_id": "11111111", "partial_total": 132, "fullfillment": false, "installment": 1, "total": 132, "ProductsSold": [ { "_id": "61603c4c6c914637d0232e00", "id": "1", "order_id": "1", "reference": "1111", "original_name": "Produto Teste", "price": 132, "quantity": 1, "product_id": "111", "variant_id": "222" } ], "Payment": [ { "_id": "61603c4c6c914637d0232e01", "date": "2021-07-07", "id": "1", "method": "money", "value": "132", "installment": 1 } ], "log": [], "createdAt": "2021-10-08T12:40:44.782Z", "updatedAt": "2021-10-08T12:56:36.970Z", "idERP_Order": 1, "__v": 0 } } ``` {% endtab %} {% tab title="400 Exemplo de response com erro de validação." %} ``` { "errors": { "body": [ { "keyword": "enum", "dataPath": ".status", "schemaPath": "#/properties/status/enum", "params": { "allowedValues": [ "aprovado", "faturado", "cancelado" ] }, "message": "should be equal to one of the allowed values" } ] } } ``` {% endtab %} {% endtabs %} **Somente poderá ser atualizado o status do pedido com os valores aceitos.** ``` ## Exemplo de Body ## { "status": "aprovado" } ``` ## Cria pedido, no ambiente de teste `GET` `test/v1/order/test` SOMENTE PARA O AMBIENTE DE TESTES COM A URL\_BASE = /test #### Headers | Name | Type | Description | | ------------- | ------ | ------------------------------- | | Authorization | String | Access token para autenticação. | {% tabs %} {% tab title="201: Created " %} { "message": "Pedido Cadastrado" } {% endtab %} {% endtabs %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://expedy.gitbook.io/openapi/order.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.