Pedido

Filtros

Pode-se utilizar filtros para restringir o retorno de dados. São utilizados, passando um parâmetro na URL requisitada. Observe a tabela de possíveis filtros abaixo.

ParamDescriçãoTipoValoresEx
statusFiltra status do pedidostringopen, canceled, archived?status=open
payment_statusFiltra status do pagamento, pode ser agrupado por waiting, canceled ou approvedstringpending, paid, voided, approved, denied, expired, refunded, chargeback?payment_status=approved
fulfillment_statusFiltra o status Fulfillmentstringattended, invoiced, shipped, delivered?fulfillment_status=attended
marketplaceFiltrar origem de um pedidostring
?marketplace=1
current_statusFiltrar o status do pedidostring?current_status=approved
payment_methodFiltrar método de pagamento de um pedidostringbillet, creditcard, manual?payment_method=billet
customer_idFiltras pelo ID do clienteint?customer_id=1
created_atFiltrar um pedido por data de criação, possível incluir data inicial e final (opcional)stringyyyy-mm-dd[Thh-ii-ss][--yyyy-mm-dd[Thh-ii-ss]]?created_at=2018-11-01T10:06:20
updated_atFiltrar um pedido por data de atualização, possível incluir data inicial e final (opcional)stringyyyy-mm-dd[Thh-ii-ss][--yyyy-mm-dd[Thh-ii-ss]]?updated_at=2018-11-01T10:06:20--2018-11-02T10:06:20
expires_at_maxFiltra pedido pela data de expiração máxima string2019-08-05?expires_at_max=2019-
08-05
expires_atFiltra pedido com expiração atéstring2019-08-01?expires_at=2019-
08-01


Criar um Pedido

POST https://api.dooca.store/orders

Body
{
    "customer_id": 9,
    "#customer": {
        "first_name": "Suporte",
        "last_name": "Dooca",
        "cgc": "03467931065",
        "email": "123@dooca.com.br",
        "brithday": "1987-01-01",
        "entity": "individual",
        "marketplace": false,
        "#password": "123123"
    },
    "external_id": "",
    "taxes": 3.90,
    "note": "uma nota sobre o pedido",
    "send_email": true,
    "address": {
        "name": "Sarapinga",
        "receiver": "what", 
        "zipcode": "93548192",
        "street": "Rua Sarapinga",
        "number": "90",
        "detail": "sala 204",
        "district": "Mauá",
        "city": "Novo Hamburgo",
        "state": "RS",
        "country": "BR"
    },
    "payment": {
        "name": "Nome do pagamento",
        "method": "other",
        "parcels": 1,
        "interest": 5.90
    },
    "discounts": [{
        "name": "Desconto do pedido",
        "type": "other",
        "value_type": "fixed_amount",
        "value": 10.90,
        "amount": 10.90
    }],
    "shipping": {
        "#carrier_id": 1,
        "name": "shipping name",
        "alias": "elias",
        "api": "correios",
        "price": 16.90
    },
    "items": [{
        "variation_id": 12966,
        "id_parent": null,
        "name": "Nome do Produto",
        "reference": "referencia do produto",
        "price": 20.90,
        "price_compare": 30.00,
        "quantity": 1,
        "note": "nota sobre produto"
    }],
    "marketplace": null
}
Status: 201

Editar um Pedido

PUT https://api.dooca.store/orders/:id

Parâmetro: O ID do pedido.

A edição do registro pode ser parcial ou total.

Status: 200

Consultar um Pedido pelo ID

GET https://api.dooca.store/orders/:id_order

Parâmetro: O ID do pedido.

HTTP STATUS: 200 OK
{
    "customer_id": 1,
    "#customer": {
        "first_name": "Suporte",
        "last_name": "Dooca",
        "cgc": "03467931065",
        "email": "123@dooca.com.br",
        "brithday": "1987-01-01",
        "entity": "individual",
        "marketplace": false,
        "#password": "123123"
    },
    "external_id": "",
    "taxes": 3.90,
    "note": "uma nota sobre o pedido",
    "send_email": true,
    "address": {
        "name": "Sarapinga",
        "receiver": "what", 
        "zipcode": "93548192",
        "street": "Rua Sarapinga",
        "number": "90",
        "detail": "sala 204",
        "district": "Mauá",
        "city": "Novo Hamburgo",
        "state": "RS",
        "country": "BR"
    },
    "payment": {
        "name": "Nome do pagamento",
        "method": "other",
        "parcels": 1,
        "interest": 5.90
    },
    "discounts": [{
        "name": "Desconto do pedido",
        "type": "other",
        "value_type": "fixed_amount",
        "value": 10.90,
        "amount": 10.90
    }],
    "shipping": {
        "#carrier_id": 1,
        "name": "shipping name",
        "alias": "elias",
        "api": "correios",
        "price": 16.90
    },
    "items": [{
        "variation_id": 12966,
        "id_parent": null,
        "name": "Nome do Produto",
        "reference": "referencia do produto",
        "price": 20.90,
        "price_compare": 30.00,
        "quantity": 1,
        "note": "nota sobre produto"
    }],
    "marketplace": null
}

Consultar um Pedido pelo TOKEN

GET https://api.dooca.store/orders/token/:token

Parâmetro: O TOKEN do pedido.

HTTP STATUS: 200 OK
{
    "customer_id": 1,
    "#customer": {
        "first_name": "Suporte",
        "last_name": "Dooca",
        "cgc": "03467931065",
        "email": "123@dooca.com.br",
        "brithday": "1987-01-01",
        "entity": "individual",
        "marketplace": false,
        "#password": "123123"
    },
    "external_id": "",
    "taxes": 3.90,
    "note": "uma nota sobre o pedido",
    "send_email": true,
    "address": {
        "name": "Sarapinga",
        "receiver": "what", 
        "zipcode": "93548192",
        "street": "Rua Sarapinga",
        "number": "90",
        "detail": "sala 204",
        "district": "Mauá",
        "city": "Novo Hamburgo",
        "state": "RS",
        "country": "BR"
    },
    "payment": {
        "name": "Nome do pagamento",
        "method": "other",
        "parcels": 1,
        "interest": 5.90
    },
    "discounts": [{
        "name": "Desconto do pedido",
        "type": "other",
        "value_type": "fixed_amount",
        "value": 10.90,
        "amount": 10.90
    }],
    "shipping": {
        "#carrier_id": 1,
        "name": "shipping name",
        "alias": "elias",
        "api": "correios",
        "price": 16.90
    },
    "items": [{
        "variation_id": 12966,
        "id_parent": null,
        "name": "Nome do Produto",
        "reference": "referencia do produto",
        "price": 20.90,
        "price_compare": 30.00,
        "quantity": 1,
        "note": "nota sobre produto"
    }],
    "marketplace": null
}

Listar Pedidos

GET https://api.dooca.store/orders

HTTP STATUS: 200 OK  
{
    "customer_id": 1,
    "#customer": {
        "first_name": "Suporte",
        "last_name": "Dooca",
        "cgc": "03467931065",
        "email": "123@dooca.com.br",
        "brithday": "1987-01-01",
        "entity": "individual",
        "marketplace": false,
        "#password": "123123"
    },
    "external_id": "",
    "taxes": 3.90,
    "note": "uma nota sobre o pedido",
    "send_email": true,
    "address": {
        "name": "Sarapinga",
        "receiver": "what", 
        "zipcode": "93548192",
        "street": "Rua Sarapinga",
        "number": "90",
        "detail": "sala 204",
        "district": "Mauá",
        "city": "Novo Hamburgo",
        "state": "RS",
        "country": "BR"
    },
    "payment": {
        "name": "Nome do pagamento",
        "method": "other",
        "parcels": 1,
        "interest": 5.90
    },
    "discounts": [{
        "name": "Desconto do pedido",
        "type": "other",
        "value_type": "fixed_amount",
        "value": 10.90,
        "amount": 10.90
    }],
    "shipping": {
        "#carrier_id": 1,
        "name": "shipping name",
        "alias": "elias",
        "api": "correios",
        "price": 16.90
    },
    "items": [{
        "variation_id": 12966,
        "id_parent": null,
        "name": "Nome do Produto",
        "reference": "referencia do produto",
        "price": 20.90,
        "price_compare": 30.00,
        "quantity": 1,
        "note": "nota sobre produto"
    }],
    "marketplace": null
}