> For the complete documentation index, see [llms.txt](https://desenvolvedores.skyhub.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://desenvolvedores.skyhub.com.br/comunicados/comunicados-2024/novos-campos-no-json-de-pedidos.md).

# Novos campos no JSON de Pedidos

Visando dar mais informações aos parceiros integrados, serão disponibilizadas no payload dos pedidos, dados que antes só estavam visíveis no Portal Seller. Esses campos estão divididos em 3 principais categorias, que são:

* **Promoção**
* **Subsídio de frete**
* **Cupom**

Abaixo, você pode verificar a tabela com todos os campos que serão adicionados:

{% hint style="danger" %}
Os campos referente a Frete e Cupom foram descontinuados em Março/2025.
{% endhint %}

<table><thead><tr><th width="126">Tipo</th><th width="184">Local</th><th width="133">Campo</th><th width="152">Objetivo</th><th>Endpoints afetados</th></tr></thead><tbody><tr><td>Promoção</td><td>items[].promotions[]</td><td>“value”</td><td>Informar o valor cheio da promoção aplicada no pedido</td><td>GET /queues/orders <br>/order/:code <br>/orders</td></tr><tr><td>Promoção</td><td>items[].promotions[]</td><td>“seller_value”</td><td>Informar o valor que o seller está pagando pela promoção aplicada no pedido</td><td>GET /queues/orders <br>/order/:code <br>/orders</td></tr><tr><td>Promoção</td><td>items[].promotions[]</td><td>“sponsor_value”</td><td>Informar o valor que a Americanas está pagando pela promoção aplicada no pedido</td><td>GET /queues/orders <br>/order/:code <br>/orders</td></tr><tr><td>Promoção</td><td>items[].promotions[]</td><td>“sponsor_percentage”</td><td>Informar o percentual que a Americanas está pagando pela promoção</td><td>GET /queues/orders <br>/order/:code <br>/orders</td></tr><tr><td>Promoção</td><td>items[].promotions[]</td><td>“calculation_type”</td><td>Informar o tipo do cálculo aplicado</td><td>GET /queues/orders <br>/order/:code <br>/orders</td></tr><tr><td>Promoção</td><td>items[].promotions[]</td><td>“name”</td><td>Informar o nome da promoção</td><td>GET /queues/orders <br>/order/:code <br>/orders</td></tr><tr><td>Promoção</td><td>items[].promotions[]</td><td>“category_type”</td><td>Informar a categoria da promoção Valores possíveis: CASH_DISCOUNT, CASHBACK, SCHEDULED, DISCOUNT, SUBTOTAL.</td><td>GET /queues/orders <br>/order/:code <br>/orders</td></tr><tr><td><del>Frete</del></td><td><del>items[]</del></td><td><del>"freight_take_rate_seller"</del></td><td><del>Informar o valor que o seller está pagando pelo frete</del></td><td><del>GET /queues/orders</del> <br><del>/order/:code</del> <br><del>/orders</del></td></tr><tr><td><del>Frete</del></td><td><del>items[]</del></td><td><del>"freight_take_rate_subsid y_percentage"</del></td><td><del>Informar o percentual que o seller está pagando pelo frete</del></td><td><del>GET /queues/orders</del> <br><del>/order/:code</del> <br><del>/orders</del></td></tr><tr><td><del>Cupom</del></td><td><del>Objeto “.coupon”</del></td><td><del>“category”</del></td><td><del>Informar a categoria do cupom aplicado no pedido</del></td><td><del>GET /queues/orders</del> <br><del>/order/:code</del> <br><del>/orders</del></td></tr><tr><td><del>Cupom</del></td><td><del>Objeto “.coupon”</del></td><td><del>“discount_value”</del></td><td><del>Informar o valor do desconto que o cupom aplicou no pedido</del></td><td><del>GET /queues/orders</del> <br><del>/order/:code</del> <br><del>/orders</del></td></tr><tr><td><del>Cupom</del></td><td><del>Objeto “.coupon”</del></td><td><del>“token”</del></td><td><del>Informar o nome do cupom aplicado no pedido</del></td><td><del>GET /queues/orders</del> <br><del>/order/:code</del> <br><del>/orders</del></td></tr></tbody></table>

#### Promoção - Exemplo de retorno:

> ```json
> "promotions":[
>     {
>         "calculation_type":"percentage",
>         "category_type":"CASH_DISCOUNT",
>         "name":"ACOM2028464",
>         "seller_value": 142.1,
>         "sponsor_percentage": 8.0,
>         "sponsor_value": 12.35,
>         "value": 154.45
>     }
> ]
> ```

#### <mark style="color:red;">\[DESCONTINUADO]</mark> Frete - Exemplo de retorno:

```json
"items":[
    {
        "special_price": 5.3,
        "shipping_cost": 1.99,
        "remote_store_id": null,
        "qty": 1,
        "product_id":"7891116061589",
        "original_price": 5.3,
        "name": "nameproduct",
        "listing_type_id": null,
        "id":"7891116061589",
        "gift_wrap": null,
        "detail": null,
        "delivery_line_id": null,
        "freight_take_rate_seller": 18.45,
        "freight_take_rate_subsidy_percentage": 50.0,
        "promotions":[
             {
                "calculation_type":"percentage",
                "category_type":"CASH_DISCOUNT",
                "name":"ACOM2028464",
                "seller_value": 142.1,
                "sponsor_percentage": 8.0,
                "sponsor_value": 12.35,
                "value": 154.45
            }
        ]        
```

#### <mark style="color:red;">\[DESCONTINUADO]</mark> Cupom - Exemplo de retorno:

```json
"coupon":{
    "category":"SUBTOTAL",
    "discount_value": 10.0,
    "token":"NOV010"
},
```

### Exemplo de payload completo com todos os novos campos:

```json
{
  "first_exported_at": "2017-12-17T01:07:42-02:00",
  "shipping_method_id": "123456789123",
  "updated_at": "2020-04-17T11:00:00-03:00",
  "tags": [],
  "total_ordered": 1500,
  "sync_sale_system": "Api Client",
  "shipping_carrier": "description",
  "approved_date": "",
  "shipped_date": "",
  "coupon": {
    "category": "SUBTOTAL",
    "discount_value": 10,
    "token": "NOVO10"
  },
  "billing_address": {
    "street": "Rua Tenente Cabral",
    "secondary_phone": "99 999999999",
    "region": "RJ",
    "reference": "Proximo ao terminal de onibus",
    "postcode": "20087262",
    "phone": "99 999999999",
    "number": "405",
    "neighborhood": "Centro",
    "full_name": "Nome do comprattor",
    "detail": "Detalhe",
    "country": "BR",
    "complement": "77",
    "city": "Rio de Janeiro"
  },
  "linked_order": null,
  "import_info": {
    "ss_name": "Submarino",
    "remote_id": "03-5792-01",
    "remote_code": "5792",
    "pack_id": null,
    "cart_id": null
  },
  "estimated_delivery_shift": "estimated_delivery_shift",
  "discount": 1.1,
  "items": [
    {
      "special_price": 5.3,
      "shipping_cost": 1.99,
      "remote_store_id": null,
      "qty": 1,
      "product_id": "7891116061589",
      "original_price": 5.3,
      "name": "name30",
      "listing_type_id": null,
      "id": "7891116061589",
      "gift_wrap": null,
      "detail": null,
      "delivery_line_id": null,
      "freight_take_rate_seller": 18.45,
      "freight_take_rate_subsidy_percentage": 50,
      "promotions": [
        {
          "calculation_type": "percentage",
          "category_type": "CASH_DISCOUNT",
          "name": "ACOM2028464",
          "seller_value": 142.1,
          "sponsor_percentage": 8,
          "sponsor_value": 12.35,
          "value": 154.45
        }
      ]
    }
  ],
  "shipping_estimate_id": "",
  "target_order": null,
  "expedition_limit_date": "2020-01-06T00:00:00-03:00",
  "status": {
    "type": "NEW",
    "label": "Entregue a Transportadora",
    "code": "order created"
  },
  "shipping_cost": 15.32,
  "placed_at": "2020-04-17T11:00:00-03:00",
  "shipping_method": "description",
  "shipping_address": {
    "street": "Rua Tenente Cabral",
    "secondary_phone": "99 999999999",
    "region": "RJ",
    "reference": "Proximo ao terminal de onibus",
    "postcode": "20087262",
    "phone": "99 999999999",
    "number": "405",
    "neighborhood": "Centro",
    "full_name": "Nome do comprattor",
    "detail": "Detalhe",
    "country": "BR",
    "complement": "77",
    "city": "Rio de Janeiro"
  },
  "interest": 3.54,
  "channel": "Submarino",
  "delivered_date": null,
  "delivery_contract_type": "",
  "exported_at": "2017-12-18T01:07:42-02:00",
  "imported_at": null,
  "shipments": [
    {
      "tracks": [
        {
          "url": "http://websro.correios.com.br/",
          "method": "E-sedex",
          "code": "DU037587068BR",
          "carrier": "Correios"
        }
      ],
      "items": [
        {
          "sku": "Moto GP 14 Xbox 360 Partnumber",
          "qty": 1
        }
      ],
      "delivered_carrier_date": null,
      "code": "DU037587068BR"
    }
  ],
  "sync_status": "ERROR",
  "available_to_sync": true,
  "calculation_type": "b2wentregacorreios",
  "delivery_token": {
    "takeout": null,
    "failure": null,
    "customer": null
  },
  "code": "Submarino-1157325160001-A",
  "estimated_delivery": "2020-04-17T11:00:00-03:00",
  "customer": {
    "vat_number": "78732371683",
    "phones": [
      "99 999999999"
    ],
    "name": "Nome do comprattor",
    "id_customer": "5e7b9f4acec590000d2ee884",
    "gender": "male",
    "email": "exemplo@skyhub.com.br",
    "date_of_birth": "1998-01-25"
  },
  "invoices": [
    {
      "volume_qty": 1,
      "number": "29049",
      "line": "1",
      "key": "33161207092688000126550010000290491000290493",
      "issue_date": "2016-12-18T01:07:42-02:00"
    }
  ],
  "payments": [
    {
      "value": 189.8,
      "type": null,
      "transaction_date": "2020-04-17T11:00:00-03:00",
      "status": "approved",
      "sefaz": {
        "type_integration": "1",
        "payment_indicator": "1",
        "name_payment": "Cartão de Crédito",
        "name_card_issuer": "Mastercard",
        "id_payment": "3",
        "id_card_issuer": "02"
      },
      "parcels": 5,
      "method": "CREDIT_CARD",
      "description": "No valor de: 189.8",
      "card_issuer": "MASTER",
      "autorization_id": "789"
    }
  ]
}
```

Em caso de dúvidas, estamos à disposição através do e-mail <srv.mktp.api@americanas.io>.&#x20;