Novos campos no JSON de Pedidos

A partir do dia 05/02/2024, novos campos serão disponibilizados no JSON de pedidos em nossas API's.

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:

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

Promoção - Exemplo de retorno:

"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
    }
]

Frete - Exemplo de retorno:

"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
            }
        ]        

Cupom - Exemplo de retorno:

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

Exemplo de payload completo com todos os novos campos:

{
  "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": "[e-mail]",
    "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 [e-mail].