Objetivo
A finalidade deste método é possibilitar a consulta dos pedidos.
Chamada
GET api/v1/sm/sales/orders?COMPANYNUMBER={COMPANYNUMBER}&ORDERNUMBER={ORDERNUMBER}&_pageNo={_pageNo}&_pageSize={_pageSize}
Informações para Requisição (Request Information)
Parâmetros URI (URI Parameters)
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| companynumber | Número da Empresa do Pedido | string | Obrigatório. |
| ordernumber | Número do Pedido para pesquisa | string | Não há. |
| systemafvcode | Código do sistema AFV | string | Não há |
| numberafvorder | Número do Pedido AFV | string | Não há |
| _pageNo | integer | Não há | |
| _pageSize | integer | Não há |
Parâmetros do Corpo (Body Parameters)
Não há.
Informações para Resposta (Response Information)
Descrição do Recurso (Resource Description)
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| order | Cabeçalho do Pedido | OrderPeriodSearchResponseDTO | Não há. |
| order-items | Detalhes do pedido | Collection of OrderItemsSearchResponseDTO | Não há. |
Formatos de Resposta (Response Formats)
application/json, text/json
Exemplo (Sample):
{
"order": {
"city": "sample string 1",
"general_operation_code": 1,
"ind_shipment_type": "sample string 2",
"name": "sample string 3",
"number_afv_order": 1,
"number_commercial_agent": 1,
"number_payment_form": 4,
"number_sales_segment": 5,
"number_transport_freight": 6,
"order_import_status": "sample string 7",
"order_number": 8,
"order_type": "sample string 9",
"seq_person": 10,
"state": "sample string 11",
"total": 12.1,
"update_date": "2020-09-03T10:52:53.1808446-03:00",
"street": "sample string 14",
"address_number": "sample string 15",
"neighbourhood": "sample string 16",
"complement": "sample string 17",
"country": "sample string 18",
"zipcode": "sample string 19",
"cpf_number": "sample string 20",
"rg_number": "sample string 21",
"telephone": "sample string 22",
"cellphone": "sample string 23",
"weight": 24.0,
"order_situation": "sample string 25",
"date_invoice_generation": "2020-09-03T10:52:53.1808446-03:00",
"system_afv_code": 1
},
"order-items": [
{
"access_code": "sample string 1",
"datetime_creation": "2020-09-03T10:52:53.1964689-03:00",
"description": "sample string 3",
"ind_kit": "sample string 4",
"item_notes": "sample string 5",
"number_company": 1,
"number_payment_condition ": 1,
"order_number": 1,
"ordered_item_quantity": 1.1,
"package_description": "sample string 6",
"package_quantity": 1.1,
"package_values_sales_table": 1.1,
"seq_order_item": 7,
"seq_product": 1.0,
"served_item_quantity": 1.1
},
{
"access_code": "sample string 1",
"datetime_creation": "2020-09-03T10:52:53.1964689-03:00",
"description": "sample string 3",
"ind_kit": "sample string 4",
"item_notes": "sample string 5",
"number_company": 1,
"number_payment_condition ": 1,
"order_number": 1,
"ordered_item_quantity": 1.1,
"package_description": "sample string 6",
"package_quantity": 1.1,
"package_values_sales_table": 1.1,
"seq_order_item": 7,
"seq_product": 1.0,
"served_item_quantity": 1.1
}
]
}application/xml, text/xml
Exemplo (Sample):
<OrderSearchResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Sales">
<ORDER>
<ADDRESS_NUMBER>sample string 15</ADDRESS_NUMBER>
<CELLPHONE>sample string 23</CELLPHONE>
<CITY>sample string 1</CITY>
<COMPLEMENT>sample string 17</COMPLEMENT>
<COUNTRY>sample string 18</COUNTRY>
<CPFNUMBER>sample string 20</CPFNUMBER>
<DATE_INVOICE_GENERATION>2020-09-03T10:52:53.1808446-03:00</DATE_INVOICE_GENERATION>
<GENERAL_OPERATION_CODE>1</GENERAL_OPERATION_CODE>
<IND_SHIPMENT_TYPE>sample string 2</IND_SHIPMENT_TYPE>
<NAME>sample string 3</NAME>
<NEIGHBOURHOOD>sample string 16</NEIGHBOURHOOD>
<NUMBER_AFV_ORDER>1</NUMBER_AFV_ORDER>
<NUMBER_COMMERCIAL_AGENT>1</NUMBER_COMMERCIAL_AGENT>
<NUMBER_PAYMENT_FORM>4</NUMBER_PAYMENT_FORM>
<NUMBER_SALES_SEGMENT>5</NUMBER_SALES_SEGMENT>
<NUMBER_TRANSPORT_FREIGHT>6</NUMBER_TRANSPORT_FREIGHT>
<ORDER_IMPORT_STATUS>sample string 7</ORDER_IMPORT_STATUS>
<ORDER_NUMBER>8</ORDER_NUMBER>
<ORDER_SITUATION>sample string 25</ORDER_SITUATION>
<ORDER_TYPE>sample string 9</ORDER_TYPE>
<RGNUMBER>sample string 21</RGNUMBER>
<SEQ_PERSON>10</SEQ_PERSON>
<STATE>sample string 11</STATE>
<STREET>sample string 14</STREET>
<TELEPHONE>sample string 22</TELEPHONE>
<TOTAL>12.1</TOTAL>
<UPDATE_DATE>2020-09-03T10:52:53.1808446-03:00</UPDATE_DATE>
<WEIGHT>24</WEIGHT>
<ZIPCODE>sample string 19</ZIPCODE>
</ORDER>
<ORDER_ITEMS>
<OrderItemsSearchResponseDTO>
<ACCESS_CODE>sample string 1</ACCESS_CODE>
<DATETIME_CREATION>2020-09-03T10:52:53.1964689-03:00</DATETIME_CREATION>
<DESCRIPTION>sample string 3</DESCRIPTION>
<IND_KIT>sample string 4</IND_KIT>
<ITEM_NOTES>sample string 5</ITEM_NOTES>
<NUMBER_COMPANY>1</NUMBER_COMPANY>
<NUMBER_PAYMENT_CONDITION>1</NUMBER_PAYMENT_CONDITION>
<ORDERED_ITEM_QUANTITY>1.1</ORDERED_ITEM_QUANTITY>
<ORDER_NUMBER>1</ORDER_NUMBER>
<PACKAGE_DESCRIPTION>sample string 6</PACKAGE_DESCRIPTION>
<PACKAGE_QUANTITY>1.1</PACKAGE_QUANTITY>
<PACKAGE_VALUES_SALES_TABLE>1.1</PACKAGE_VALUES_SALES_TABLE>
<SEQ_ORDER_ITEM>7</SEQ_ORDER_ITEM>
<SEQ_PRODUCT>1</SEQ_PRODUCT>
<SERVED_ITEM_QUANTITY>1.1</SERVED_ITEM_QUANTITY>
</OrderItemsSearchResponseDTO>
<OrderItemsSearchResponseDTO>
<ACCESS_CODE>sample string 1</ACCESS_CODE>
<DATETIME_CREATION>2020-09-03T10:52:53.1964689-03:00</DATETIME_CREATION>
<DESCRIPTION>sample string 3</DESCRIPTION>
<IND_KIT>sample string 4</IND_KIT>
<ITEM_NOTES>sample string 5</ITEM_NOTES>
<NUMBER_COMPANY>1</NUMBER_COMPANY>
<NUMBER_PAYMENT_CONDITION>1</NUMBER_PAYMENT_CONDITION>
<ORDERED_ITEM_QUANTITY>1.1</ORDERED_ITEM_QUANTITY>
<ORDER_NUMBER>1</ORDER_NUMBER>
<PACKAGE_DESCRIPTION>sample string 6</PACKAGE_DESCRIPTION>
<PACKAGE_QUANTITY>1.1</PACKAGE_QUANTITY>
<PACKAGE_VALUES_SALES_TABLE>1.1</PACKAGE_VALUES_SALES_TABLE>
<SEQ_ORDER_ITEM>7</SEQ_ORDER_ITEM>
<SEQ_PRODUCT>1</SEQ_PRODUCT>
<SERVED_ITEM_QUANTITY>1.1</SERVED_ITEM_QUANTITY>
</OrderItemsSearchResponseDTO>
</ORDER_ITEMS>
</OrderSearchResponseDTO>
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas