Inserir Pedidos - POST

Objetivo 

Receber, validar e persistir pedidos.

Request Information

POST: [urlBase]:[porta]/smsalesapi/api/v1/sm/sales/orders

URI Parameters

Não há.

Body Parameters

OrderDTO

Request Formats

application/json, text/json

Sample:

{
  "linkerp": 1,
  "number_payment_condition": 1,
  "address": "sample string 3",
  "address_complement": "sample string 4",
  "address_number": "sample string 5",
  "code_card_operator": 1,
  "city": "sample string 6",
  "cnpj": "sample string 7",
  "cpf": "sample string 8",
  "customer_shipment_name": "sample string 9",
  "customer_shipment_number_cpf": "sample string 10",
  "customer_shipment_phone_area_code_1": "sample string 11",
  "customer_shipment_phone_area_code_2": "sample string 12",
  "customer_shipment_phone_complement_1": "sample string 13",
  "customer_shipment_phone_complement_2": "sample string 14",
  "customer_shipment_phone_number_1": "sample string 15",
  "customer_shipment_phone_number_2": "sample string 16",
  "customer_shipment_rg_number": "sample string 17",
  "datetime_end_delivery_forecast": "sample string 18",
  "datetime_forwarding_forecast": "sample string 19",
  "datetime_shipment": "sample string 20",
  "datetime_start_delivery_forecast": "sample string 21",
  "district": "sample string 22",
  "ecommerce_status": "sample string 23",
  "id_ecommerce_transaction": "sample string 24",
  "ind_shipment_type": "sample string 25",
  "invoicement_base_date": "sample string 26",
  "items": [
    {
      "ind_ecommerce_similar": "sample string 3",
      "ind_kit": "sample string 4",
      "item_notes": "sample string 5",
      "item_quantity": "sample string 6",
      "multiplier_factor": 1.1,
      "number_sales_table": "sample string 7",
      "package_quantity": "sample string 8",
      "package_reported_value": "sample string 9",
      "package_values_sales_table": "sample string 10",
      "selling_price": "sample string 11",
      "seq_product": 12,
      "seq_grid": 1,
      "seq_web_order": 1,
      "seq_web_order_item": 1,
      "site_quantity": "sample string 13",
      "value_package_discount": "sample string 14",
      "site_package_value": "sample string 15",
      "value_sales_table": "sample string 16"
    },
    {
      "ind_ecommerce_similar": "sample string 3",
      "ind_kit": "sample string 4",
      "item_notes": "sample string 5",
      "item_quantity": "sample string 6",
      "multiplier_factor": 1.1,
      "number_sales_table": "sample string 7",
      "package_quantity": "sample string 8",
      "package_reported_value": "sample string 9",
      "package_values_sales_table": "sample string 10",
      "selling_price": "sample string 11",
      "seq_product": 12,
      "seq_grid": 1,
      "seq_web_order": 1,
      "seq_web_order_item": 1,
      "site_quantity": "sample string 13",
      "value_package_discount": "sample string 14",
      "site_package_value": "sample string 15",
      "value_sales_table": "sample string 16"
    }
  ],
  "cards": [
    {
      "value": 1.1,
      "code_card_operator": "sample string 2",
      "number_gift_card": 3,
      "number_card": 4,
      "number_portion": 5,
      "cpf_card": "sample string 6",
      "cnpj_card": "sample string 7",
      "quantity_attempts": 8
    },
    {
      "value": 1.1,
      "code_card_operator": "sample string 2",
      "number_gift_card": 3,
      "number_card": 4,
      "number_portion": 5,
      "cpf_card": "sample string 6",
      "cnpj_card": "sample string 7",
      "quantity_attempts": 8
    }
  ],
  "name": "sample string 27",
  "number_commercial_agent": 1,
  "number_company": "sample string 28",
  "number_customer_order": "sample string 29",
  "number_ecommerce_company": "sample string 30",
  "number_ecommerce_order": 31,
  "number_of_installments": 1,
  "number_payment_form": 1,
  "number_sales_table": "sample string 32",
  "order_date": "sample string 33",
  "order_notes": "sample string 34",
  "order_status": "sample string 35",
  "order_type": "sample string 36",
  "separation_priority": "sample string 37",
  "seq_grid": 1,
  "seq_web_order": 1,
  "state": "sample string 38",
  "value_accessory_expenses": "sample string 39",
  "freight_value": "sample string 40",
  "value_round_ecommerce": "sample string 41",
  "zip_code": "sample string 42",
  "web_order_costumer": {
    "approved_amount": 1,
    "canceled_amount": 2,
    "waitingpayement_amount": 3
  },
  "number_afv_order": 1,
  "pedido_id": "sample string 43",
  "number_sales_segment": 1,
  "cgo": 1
}

application/xml, text/xml

Sample:

<OrderDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Sales">
  <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">1</_pageNo>
  <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">2</_pageSize>
  <ADDRESS>sample string 3</ADDRESS>
  <ADDRESS_COMPLEMENT>sample string 4</ADDRESS_COMPLEMENT>
  <ADDRESS_NUMBER>sample string 5</ADDRESS_NUMBER>
  <CARDS>
    <OrderCardsDTO>
      <CNPJ_CARD>sample string 7</CNPJ_CARD>
      <CODE_CARD_OPERATOR>sample string 2</CODE_CARD_OPERATOR>
      <CPF_CARD>sample string 6</CPF_CARD>
      <NUMBER_CARD>4</NUMBER_CARD>
      <NUMBER_GIFT_CARD>3</NUMBER_GIFT_CARD>
      <NUMBER_PORTION>5</NUMBER_PORTION>
      <QUANTITY_ATTEMPTS>8</QUANTITY_ATTEMPTS>
      <VALUE>1.1</VALUE>
    </OrderCardsDTO>
    <OrderCardsDTO>
      <CNPJ_CARD>sample string 7</CNPJ_CARD>
      <CODE_CARD_OPERATOR>sample string 2</CODE_CARD_OPERATOR>
      <CPF_CARD>sample string 6</CPF_CARD>
      <NUMBER_CARD>4</NUMBER_CARD>
      <NUMBER_GIFT_CARD>3</NUMBER_GIFT_CARD>
      <NUMBER_PORTION>5</NUMBER_PORTION>
      <QUANTITY_ATTEMPTS>8</QUANTITY_ATTEMPTS>
      <VALUE>1.1</VALUE>
    </OrderCardsDTO>
  </CARDS>
  <CODE_CARD_OPERATOR>1</CODE_CARD_OPERATOR>
  <CGO>1</CGO>
  <CITY>sample string 6</CITY>
  <CNPJ>sample string 7</CNPJ>
  <CPF>sample string 8</CPF>
  <CUSTOMER_SHIPMENT_NAME>sample string 9</CUSTOMER_SHIPMENT_NAME>
  <CUSTOMER_SHIPMENT_NUMBER_CPF>sample string 10</CUSTOMER_SHIPMENT_NUMBER_CPF>
  <CUSTOMER_SHIPMENT_PHONE_AREA_CODE_1>sample string 11</CUSTOMER_SHIPMENT_PHONE_AREA_CODE_1>
  <CUSTOMER_SHIPMENT_PHONE_AREA_CODE_2>sample string 12</CUSTOMER_SHIPMENT_PHONE_AREA_CODE_2>
  <CUSTOMER_SHIPMENT_PHONE_COMPLEMENT_1>sample string 13</CUSTOMER_SHIPMENT_PHONE_COMPLEMENT_1>
  <CUSTOMER_SHIPMENT_PHONE_COMPLEMENT_2>sample string 14</CUSTOMER_SHIPMENT_PHONE_COMPLEMENT_2>
  <CUSTOMER_SHIPMENT_PHONE_NUMBER_1>sample string 15</CUSTOMER_SHIPMENT_PHONE_NUMBER_1>
  <CUSTOMER_SHIPMENT_PHONE_NUMBER_2>sample string 16</CUSTOMER_SHIPMENT_PHONE_NUMBER_2>
  <CUSTOMER_SHIPMENT_RG_NUMBER>sample string 17</CUSTOMER_SHIPMENT_RG_NUMBER>
  <DATETIME_END_DELIVERY_FORECAST>sample string 18</DATETIME_END_DELIVERY_FORECAST>
  <DATETIME_FORWARDING_FORECAST>sample string 19</DATETIME_FORWARDING_FORECAST>
  <DATETIME_SHIPMENT>sample string 20</DATETIME_SHIPMENT>
  <DATETIME_START_DELIVERY_FORECAST>sample string 21</DATETIME_START_DELIVERY_FORECAST>
  <DISTRICT>sample string 22</DISTRICT>
  <ECOMMERCE_STATUS>sample string 23</ECOMMERCE_STATUS>
  <ID_ECOMMERCE_TRANSACTION>sample string 24</ID_ECOMMERCE_TRANSACTION>
  <IND_SHIPMENT_TYPE>sample string 25</IND_SHIPMENT_TYPE>
  <INVOICEMENT_BASE_DATE>sample string 26</INVOICEMENT_BASE_DATE>
  <ITEMS>
    <OrderItemsDTO>
      <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">1</_pageNo>
      <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">2</_pageSize>
      <IND_ECOMMERCE_SIMILAR>sample string 3</IND_ECOMMERCE_SIMILAR>
      <IND_KIT>sample string 4</IND_KIT>
      <ITEM_NOTES>sample string 5</ITEM_NOTES>
      <ITEM_QUANTITY>sample string 6</ITEM_QUANTITY>
      <MULTIPLIER_FACTOR>1.1</MULTIPLIER_FACTOR>
      <NUMBER_SALES_TABLE>sample string 7</NUMBER_SALES_TABLE>
      <PACKAGE_QUANTITY>sample string 8</PACKAGE_QUANTITY>
      <PACKAGE_REPORTED_VALUE>sample string 9</PACKAGE_REPORTED_VALUE>
      <PACKAGE_VALUES_SALES_TABLE>sample string 10</PACKAGE_VALUES_SALES_TABLE>
      <SELLING_PRICE>sample string 11</SELLING_PRICE>
      <SEQ_PRODUCT>12</SEQ_PRODUCT>
      <SEQ_WEB_GRID>1</SEQ_WEB_GRID>
      <SEQ_WEB_ORDER>1</SEQ_WEB_ORDER>
      <SEQ_WEB_ORDER_ITEM>1</SEQ_WEB_ORDER_ITEM>
      <SITE_QUANTITY>sample string 13</SITE_QUANTITY>
      <VALUE_PACKAGE_DISCOUNT>sample string 14</VALUE_PACKAGE_DISCOUNT>
      <VALUE_PACKAGE_SITE>sample string 15</VALUE_PACKAGE_SITE>
      <VALUE_SALES_TABLE>sample string 16</VALUE_SALES_TABLE>
    </OrderItemsDTO>
    <OrderItemsDTO>
      <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">1</_pageNo>
      <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">2</_pageSize>
      <IND_ECOMMERCE_SIMILAR>sample string 3</IND_ECOMMERCE_SIMILAR>
      <IND_KIT>sample string 4</IND_KIT>
      <ITEM_NOTES>sample string 5</ITEM_NOTES>
      <ITEM_QUANTITY>sample string 6</ITEM_QUANTITY>
      <MULTIPLIER_FACTOR>1.1</MULTIPLIER_FACTOR>
      <NUMBER_SALES_TABLE>sample string 7</NUMBER_SALES_TABLE>
      <PACKAGE_QUANTITY>sample string 8</PACKAGE_QUANTITY>
      <PACKAGE_REPORTED_VALUE>sample string 9</PACKAGE_REPORTED_VALUE>
      <PACKAGE_VALUES_SALES_TABLE>sample string 10</PACKAGE_VALUES_SALES_TABLE>
      <SELLING_PRICE>sample string 11</SELLING_PRICE>
      <SEQ_PRODUCT>12</SEQ_PRODUCT>
      <SEQ_WEB_GRID>1</SEQ_WEB_GRID>
      <SEQ_WEB_ORDER>1</SEQ_WEB_ORDER>
      <SEQ_WEB_ORDER_ITEM>1</SEQ_WEB_ORDER_ITEM>
      <SITE_QUANTITY>sample string 13</SITE_QUANTITY>
      <VALUE_PACKAGE_DISCOUNT>sample string 14</VALUE_PACKAGE_DISCOUNT>
      <VALUE_PACKAGE_SITE>sample string 15</VALUE_PACKAGE_SITE>
      <VALUE_SALES_TABLE>sample string 16</VALUE_SALES_TABLE>
    </OrderItemsDTO>
  </ITEMS>
  <NAME>sample string 27</NAME>
  <NUMBER_AFV_ORDER>1</NUMBER_AFV_ORDER>
  <NUMBER_COMMERCIAL_AGENT>1</NUMBER_COMMERCIAL_AGENT>
  <NUMBER_COMPANY>sample string 28</NUMBER_COMPANY>
  <NUMBER_CUSTOMER_ORDER>sample string 29</NUMBER_CUSTOMER_ORDER>
  <NUMBER_ECOMMERCE_COMPANY>sample string 30</NUMBER_ECOMMERCE_COMPANY>
  <NUMBER_ECOMMERCE_ORDER>31</NUMBER_ECOMMERCE_ORDER>
  <NUMBER_OF_INSTALLMENTS>1</NUMBER_OF_INSTALLMENTS>
  <NUMBER_PAYMENT_CONDITION>1</NUMBER_PAYMENT_CONDITION>
  <NUMBER_PAYMENT_FORM>1</NUMBER_PAYMENT_FORM>
  <NUMBER_SALES_SEGMENT>1</NUMBER_SALES_SEGMENT>
  <NUMBER_SALES_TABLE>sample string 32</NUMBER_SALES_TABLE>
  <ORDER_DATE>sample string 33</ORDER_DATE>
  <ORDER_NOTES>sample string 34</ORDER_NOTES>
  <ORDER_STATUS>sample string 35</ORDER_STATUS>
  <ORDER_TYPE>sample string 36</ORDER_TYPE>
  <PEDIDO_ID>sample string 43</PEDIDO_ID>
  <SEPARATION_PRIORITY>sample string 37</SEPARATION_PRIORITY>
  <SEQ_WEB_GRID>1</SEQ_WEB_GRID>
  <SEQ_WEB_ORDER>1</SEQ_WEB_ORDER>
  <STATE>sample string 38</STATE>
  <VALUE_ACCESSORY_EXPENSES>sample string 39</VALUE_ACCESSORY_EXPENSES>
  <VALUE_FREIGHT>sample string 40</VALUE_FREIGHT>
  <VALUE_ROUND_ECOMMERCE>sample string 41</VALUE_ROUND_ECOMMERCE>
  <WEB_ORDER_COSTUMER>
    <APPROVED_AMOUNT>1</APPROVED_AMOUNT>
    <CANCELED_AMOUNT>2</CANCELED_AMOUNT>
    <WAITINGPAYEMENT_AMOUNT>3</WAITINGPAYEMENT_AMOUNT>
  </WEB_ORDER_COSTUMER>
  <ZIP_CODE>sample string 42</ZIP_CODE>
  <linkerp>1</linkerp>
</OrderDTO>

Response Information

Response Codes

• OK (200)
• BadRequest (400)
• Unauthorized (401)
• InternalServerError (500)

Resource Description

OrderResponseDTO

Response Formats

application/json, text/json

Sample:

{
  "message_review": "sample string 1",
  "order": {
    "seq_pedido": 1,
    "status": "sample string 2",
    "order_number": 3,
    "critic_type": "sample string 4",
    "critic_list": [
      {
        "TYPE_CRITIC": "sample string 1",
        "CRITIC_LIST": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "TYPE_CRITIC": "sample string 1",
        "CRITIC_LIST": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "callback_url": "sample string 5"
  }
}

application/xml, text/xml

Sample:

<OrderResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Sales">
  <MESSAGE_REVIEW>sample string 1</MESSAGE_REVIEW>
  <ORDER>
    <CALLBACKURL>sample string 5</CALLBACKURL>
    <CRITIC_LIST xmlns:d3p1="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.Commom">
      <d3p1:OrderCriticResponseDto>
        <d3p1:CRITIC_LIST xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:CRITIC_LIST>
        <d3p1:TYPE_CRITIC>sample string 1</d3p1:TYPE_CRITIC>
      </d3p1:OrderCriticResponseDto>
      <d3p1:OrderCriticResponseDto>
        <d3p1:CRITIC_LIST xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:CRITIC_LIST>
        <d3p1:TYPE_CRITIC>sample string 1</d3p1:TYPE_CRITIC>
      </d3p1:OrderCriticResponseDto>
    </CRITIC_LIST>
    <CRITIC_TYPE>sample string 4</CRITIC_TYPE>
    <NUMBER_ORDER>3</NUMBER_ORDER>
    <SEQ_ORDER>1</SEQ_ORDER>
    <STATUS>sample string 2</STATUS>
  </ORDER>
</OrderResponseDTO>