Informações Técnicas
Características
Tipo de API | Tipo de DSP | Versão DCP | Complexidade |
|---|---|---|---|
Obter dados do BRP | DMS | V3 - Internacional | Baixo |
Enviar dados para o BRP | CRM | V4 - América do Norte | Um pouco mais |
Transação com BRP | | | Um pouco mais |
Autenticação
A API está usando Autenticação do Revendedor e Autenticação da Aplicação.
Autenticação da Aplicação
Você precisa de um token de acesso válido antes de chamar esta API, ou você deve chamar o API de Autenticação de Aplicativos para obter um.
O token de acesso é válido por 30 minutos! (1799 segundos)
Autenticação do Revendedor
Você precisa de um token de acesso válido antes de chamar esta API, ou você deve chamar o API de Autenticação do Revendedor para obter um.
O access_token é válido por 2 horas.
Você precisa usar o refresh_token para obter um access_token antes que o atual expire.
❗❗ O access_token obtido através da API de Autenticação do Revendedor deve ser para o revendedor cujo número de revendedor é usado no dealer_no campo da carga útil ou do cabeçalho ❗❗
Veja a seção Login do Revendedor para mais informações.
Consulte o Autenticação do Revendedor e API de Autenticação do Revendedor seções para mais informações.
URL Base
Teste | https://qa-cloud-api.brp.com/dcp/<v3 ou v4> |
|---|---|
Produção | https://cloud-api.brp.com/dcp/<v3 ou v4> |
Recurso: Pedido de Peças
O Pedido de Peças recurso é utilizado ao chamar a API para validar, verificar e criar um pedido.
Representação JSON
{
"pac_order_id": "62e9969d-ee6b-44af-a70f-acc3400df20c",
"dealer_po_no": "PO0001234",
"dealer_no": "0000697938",
"shipping_carrier": {
"shipping_condition": "30"
},
"partner": {
"bill_to_no": "0000697938",
"ship_to_no": "0000697938"
},
"header_texts": [
{
"code": "shipping_instruction",
"descr": "Delivery at door 245" }
],
"items": [
{
"item_id": "460f166e-b0dd-4f74-8c61-4112a1ec2aab",
"dealer_po_item_no": "A-0010",
"dealer_product_code": "409209700-DMS",
"product_code": "409209700",
"order_qty": 1,
"texts": [
{
"code": "memo_field",
"descr": "For customer ABC"
}
]
},
{
"item_id": "e3afa79f-2953-caf5-858d-842b2b523deb",
"dealer_po_item_no": "A-0020",
"dealer_product_code": "0460540-DMS",
"product_code": "0460540",
"order_qty": 1,
"texts": [
{
"code": "memo_field",
"descr": "For customer ABC"
}
]
}
]
}Propriedades
Propriedade | Tipo | Definição | Notas |
|---|---|---|---|
pac_order_id * | string | Código que identifica exclusivamente o pedido de compra, representado por um GUID. | Comprimento Máximo:36 |
data_de_criação* | data e hora | Data e hora em que o pedido de compra foi criado em seu DMS, em ISO 8601 formato. | Formato: AAAA-MM-DDTHH:MM:SSZ |
número_do_pedido_do_revendedor* | string | O número do pedido que o cliente usa para identificar um pedido de compra de forma única. | Comprimento máximo:35 |
número_do_concessionário* | string | Código que identifica exclusivamente um revendedor. Deve ter 10 caracteres. Se houver menos de 10 caracteres, adicione '0' no início. | Comprimento:10 |
transportadora* | objeto | O objeto Transportadora de Envio é usado para selecionar o método de envio | |
transportadora .condição_de_envio* | string | Código personalizado BRP que identifica de forma exclusiva o método de envio pelo qual o pedido é entregue. Um valor da Método de Envio tabela. | |
parceiro | objeto | Lista de parceiros utilizados na ordem de venda do cliente. |
|
parceiro.faturar_para_número | string | Código que identifica exclusivamente o revendedor que é faturado pelo pedido. Deve ter 10 caracteres. Se tiver menos de 10 caracteres, adicione '0' no início. | Comprimento:10 |
parceiro.enviar_para_nº | string | Código que identifica exclusivamente o revendedor que receberá o pedido. Deve ter 10 caracteres. Se tiver menos de 10 caracteres, adicione '0' no início. | Comprimento:10 |
textos_do_cabeçalho | lista de objetos | Lista de linhas de texto do cabeçalho para o pedido de compra. |
|
cabeçalho_textos.código | string | Código identificador do tipo de texto. Deve ser instrução_de_envio |
|
descrição_textos.cabeçalho | cadeia | Texto aplicado ao código de texto | Comprimento Máximo:132 |
itens* | lista de objetos | A lista de itens sendo pedidos. | |
itens.linha_pedido* | objeto | A descrição do item. | |
itens.pedido_linha .item_id* | string | Código que identifica exclusivamente o número do item, representado por um GUID. | Comprimento Máximo:36 |
itens.pedido_linha .código_do_produto* | string | Código que identifica exclusivamente um produto BRP. | Comprimento Máximo: 18 |
itens.pedido_linha .quantidade_pedido* | iinteiro | A quantidade total do pedido para este item. | |
itens.pedido_linha .número_item_pedido_fornecedor* | string | O número da linha fornecido pelo solicitante é usado como referência para o item do pedido de compra. | Max Length:6 |
itens.pedido_linha .código_do_produto_do_revendedor | string | Código do produto do cliente fornecido pelo solicitante e usado como referência ao código do produto BRP. | Comprimento Máximo:35 |
itens.linha_pedido .textos | lista de objetos | Lista de linhas de texto para o documento de venda do item. |
|
itens.linha_pedido .textos.código | string | Código identificando o tipo de texto. Deve ser campo_memo. |
|
itens.linha_pedido .texts.descr | string | Texto aplicado ao código de texto. | Comprimento Máximo:120
|
* Esses campos são obrigatórios.
Tabelas de Referência
Métodos de Envio - América do Norte
Código V3 | Código V4 | Descrição | Use |
|---|---|---|---|
01 | S1 | Transporte Terrestre Acelerado | First level update of domestic standard:
|
02 | S2 | Veículo Fora de Serviço | O envio mais rápido disponível. Isso é comumente usado quando os atrasos na entrega são críticos (cenários de veículo parado):
|
03 | S3 | Vehicle Out of Service | Even if the Vehicle Below has the capacity to be received on a Saturday. |
Métodos de Envio - Internacional
Organização de Vendas | Código V3 | Description |
|---|---|---|
6030 - Escandinávia | 50 | itella |
6030 - Escandinávia | 51 | logística de postagem |
6030 - Scandinávia | 52 | earth |
6030 - Escandinávia | 53 | ar |
6030 - Escandinávia | 54 | earth |
6030 - Escandinávia | 55 | ar |
6030 - Escandinávia | 59 | earth |
6030 - Escandinávia | 60 | ar |
6050 - Europa (emea) | 30 | regular |
6050 - Europa (emea) | 33 | press |
7080 - Asia-Pacífico (apac) | 38 | regular |
7080 - Ásia-Pacífico (apac) | 39 | press |
7080 - Ásia-Pacífico (apac) | 40 | regular |
7080 - Ásia-Pacífico (apac) | 82 | estoque |
7080 - Ásia-Pacífico (apac) | 90 | estoque |
8070 - México | 92 | regular |
8070 - México | 93 | ar |
8070 - México | 94 | press |
8075 - Brasil | 63 | carga_aérea_azul |
8075 - Brasil | 77 | sedex_correios |
8075 - Brasil | 78 | road standard |
Recurso: Resposta do Pedido de Peças
Todas as chamadas de API retornam o recurso de Resposta do Pedido de Peças, que contém informações sobre o pedido de peças.
Representação JSON
{
"pac_order_id": "iRlurO0n7j{Wddjpe1FYwG",
"sales_order_no": "1031037894",
"creation_date": "2024-10-02T19:23:52Z",
"dealer_po_no": "PO TC02 TCS1",
"dealer_no": "0000690012",
"order_type": "regular",
"shipping_carrier": {
"shipping_condition": "S0",
"shipping_condition_descr": "Standard Ground"
},
"payment_terms": "F030",
"payment_terms_descr": "Fin. (PA&A) - Due in 30 days",
"partners": [],
"pricings": [
{
"condition_type": "gross_amt",
"total_amount": 34.48,
"currency": "USD"
},
{
"condition_type": "tax_amt",
"total_amount": 3,
"currency": "USD"
},
{
"condition_type": "handling_fee",
"total_amount": 20,
"currency": "USD"
},
{
"condition_type": "subtotal_amt",
"total_amount": 54.48,
"currency": "USD"
}
],
"header_texts": [
{
"code": "shipping_instruction",
"descr": "Delivery at door 245"
}
],
"header_statuses": [
{
"type": "success",
"code": "",
"descr": "Your order has been created successfully"
},
{
"type": "warning",
"code": "",
"descr": "Pay special attention to the status of certain part"
},
{
"type": "warning",
"code": "",
"descr": "Your PAA order is less than 250.00$, handling fee of 20.00$ will be applied to the invoice."
}
],
"items": [
{
"ordered_line": {
"item_id": "B1BBF8D580311EDFA09E7B73A01422E9",
"item_no": "000100",
"parent_item_no": "000000",
"product_code": "715004887",
"product_descr": "SUPPORT KIT",
"order_qty": 1,
"dealer_po_item_no": "A-0010",
"dealer_product_code": "",
"sales_uom": "PC",
"min_order_qty": 1,
"is_sales_bom": false,
"product_line": "SSV",
"product_type": "40",
"texts": [
{
"code": "memo_field",
"descr": "For customer ABC"
}
]
},
"shipping_lines": [
{
"item_no": "000101",
"parent_item_no": "000100",
"product_code": "715004887",
"product_descr": "SUPPORT KIT",
"ship_qty": 1,
"sales_uom": "PC",
"price_uom": "PC",
"package_uom": "PC",
"in_package": {
"qty": 1,
"uom": "PC"
},
"package_count": 1,
"msrp_unit_price": 57.99,
"wholesale_unit_price": 34.48,
"net_unit_price": 54.48,
"currency": "USD",
"is_substitute_product": false,
"substituted_product_code": null,
"product_line": "SSV",
"product_type": "40",
"plant": {
"name": "BRP - SAINT-JEAN-SUR-RICHELIEU",
"city": "ST-JEAN-SUR-RICHELIEU",
"state": "QC",
"country": "CA"
},
"pricings": [
{
"condition_type": "gross_amt",
"total_amount": 34.48,
"currency": "USD"
},
{
"condition_type": "tax_amt",
"total_amount": 3,
"currency": "USD"
},
{
"condition_type": "subtotal_amt",
"total_amount": 54.48,
"currency": "USD"
},
{
"condition_type": "handling_fee",
"total_amount": 20,
"currency": "USD"
}
],
"deliveries": [
{
"status_code": "backorder",
"status_date": "2024-10-02T15:23:53Z",
"status_descr": "",
"qty": 1,
"availability_date": "2025-01-10",
"no": "",
"item_no": "",
"delivery_qty": 0,
"creation_date": "",
"carrier_name": "",
"split_delivery_no": "",
"split_delivery_item_no": "",
"billings": []
}
],
"statuses": [
{
"type": "success",
"code": "",
"descr": "Your part has been created successfully"
}
]
}
]
}
]
}
Propriedades
Todos os campos numéricos com decimais usam o ponto (.) como separador decimal. A vírgula (,) não é SUPORTADA como separador decimal.
Propriedade | Tipo | Definição | Notas |
|---|---|---|---|
pac_id_pedido | string | Código que identifica exclusivamente o número do pedido de compra, representado por um GUID. V3: o GUID que você enviou para validar e criar. V4: um novo GUID alocado pela SAP. | Comprimento Máximo:36 |
número_do_pedido_de_venda | string | Apenas V4 Código que identifica exclusivamente o documento de vendas. ❗❗ A propriedade está vazia na resposta retornada pelo Validar serviço.
| Comprimento Máximo:10 |
data_de_criação | data e hora | Data e hora em que o pedido de compra foi criado. | Formato: AAAA-MM-DDTHH:MM:SSZ |
número_do_pedido_do_revendedor | string | O número que o cliente usa para identificar exclusivamente o pedido de compra. Apenas letras, números e espaços são permitidos. | Comprimento máximo:35 Apenas letras, números e espaços são permitidos. |
número_do_concessionário | string | Código que identifica exclusivamente o revendedor que cria o pedido de compra. | Comprimento:10 |
tipo_de_pedido | string | Uma classificação que distingue entre diferentes tipos de ordens de compra. Um dos:
|
|
transportadora | objeto | O objeto Transportadora de Envio é usado para descrever como o envio será feito. |
|
transportadora .condição_de_envio | string | Um dos valores da Métodos de Envio tabela abaixo. |
|
transportadora .descrição_da_condição_de_envio | string | Descrição da condição de envio. |
|
termos_de_pagamento | string | Código para indicar o prazo de pagamento. |
|
descrição_dos_termos_de_pagamento † | string | Descrição do termo de pagamento. |
|
parceiros* | Lista de objetos | Lista de parceiros utilizados na ordem de compra para enviar e faturar o pedido. |
|
tipo de parceiros | cadeia | Um dos:
| Comprimento Máximo:2 |
parceiros.no | string | Número do cliente parceiro. | Comprimento:10 |
nome dos parceiros | cadeia | Nome comercial do parceiro. | Comprimento Máximo:80 |
endereço dos parceiros | objeto | Endereço do parceiro. |
|
endereço.parceiros.rua | string | Endereço da rua (1ª linha) | Comprimento Máximo:60 |
parceiros.endereço.cidade | string | Nome da cidade. | Comprimento Máximo:40 |
parceiros.endereço.estado | string | Código que identifica exclusivamente uma província/estado/região em um país, em ISO 3166-2 (2ª parte) formato. | Comprimento Máximo:3 |
parceiros.endereço.país | string | Código que identifica exclusivamente um país, em ISO 3166-1 formato. | Comprimento Máximo:2 |
endereço dos parceiros .código_postal | string | Código postal do parceiro. | Comprimento Máximo:10 |
preços | lista de objetos | Lista de diferentes valores relacionados ao pedido de compra. |
|
tipo_de_condição_de_preço | String | Tipo de valor. Um dos :
|
|
preço.valor_total | número | Valor total aplicado ao tipo de valor. | Precisão:0.01 |
preço.moeda | string | Uma das moedas do Moeda tabela abaixo, na qual o valor é fornecido. | Comprimento Máximo:5 |
textos_do_cabeçalho | lista de objetos | Lista de texto de cabeçalho relacionado ao pedido de compra. |
|
cabeçalho_textos.código | string | Código identificando o tipo de texto. Deve ser instrução_de_envio. |
|
texto_do_cabeçalho.descr | string | Texto aplicado ao código de texto | Comprimento Máximo:132 |
status_do_cabeçalho | lista de objetos | Informações de status relacionadas ao pedido de compra. |
|
cabeçalho_statuses.tipo | string | O tipo de status indica a gravidade da mensagem para o pedido de compra. Um dos:
|
|
cabeçalho_statuses.código | string | Código de status relacionado ao documento de vendas. Um dos:
|
|
status_header.descr † | string | Texto de status relacionado ao código de status. | Comprimento Máximo:132 |
itens | lista de objetos | A lista de itens pedidos. |
|
itens.linha_pedida | objeto | Uma descrição do item da linha. |
|
itens.pedido_linha .id_item | string | Código que identifica exclusivamente o número do item, representado por um GUID. V3: o GUID que você enviou para validar e criar. V4: um novo GUID alocado pela SAP. | Comprimento Máximo:36 |
itens.linha_pedida .número_do_pedido_de_venda | string | Apenas V3 O número que identifica exclusivamente o documento de vendas. | Comprimento Máximo:10 |
itens.linha_pedida .item_no | string | O número identifica exclusivamente o item no documento de vendas. | Comprimento Máximo:6 |
🆕 itens.pedido_linha .item_pai_não | string | Apenas V4 O número identifica exclusivamente o item no documento de vendas que é o pai deste item. | Comprimento Máximo:6 |
itens.linha_pedida .código_do_produto | cadeia | Código que identifica exclusivamente um produto BRP. | Comprimento Máximo:18 |
itens.linha_pedida .descrição_do_produto † | string | Descrição do produto. | Comprimento Máximo:40 |
itens.linha_pedida .quantidade_pedido | inteiro | A quantidade total do pedido para este item. | |
itens.linha_encomendada .número_item_pedido_fornecedor | string | A string do número da linha fornecida pelo solicitante é usada como referência para o item do pedido de compra. | Comprimento Máximo:6 |
itens.linha_pedida .código_produto_concessionário | string | Código do produto do cliente fornecido pelo solicitante e usado como referência ao código do produto BRP. | Comprimento Máximo:35 |
itens.linha_pedida .unidade_de_venda | string | Uma das unidades de medida de vendas da Unidades de Medida tabela. | Comprimento Máximo:3 |
itens.linha_pedida .quantidade_minima_pedido | inteiro | A quantidade mínima de pedido para o produto, em unidades de medida de vendas. | |
itens.linha_pedida .é_venda_bom | Booleano | Indique se a parte solicitada é uma Lista de Materiais (BOM). Uma parte BOM contém muitas subpartes. |
|
itens.linha_pedida .linha_de_produto | String | Linha de produtos à qual este produto está associado. Um dos valores da Linhas de Produtos tabela. |
|
itens.linha_pedida .tipo_de_produto | string | Um valor do Tipo de Produto abaixo. |
|
itens.linha_pedida .textos | lista de objetos | Texto relacionado ao item da linha. |
|
itens.linha_pedido .textos.código | string | Código identificando o tipo de texto. Deve ser campo_memo. |
|
itens.linha_pedida .texts.descr † | string | Texto aplicado ao código de texto. | Comprimento Máximo:120
|
itens.linhas_de_envio | lista de objeto | Linhas com informações de envio para o revendedor. |
|
itens.linhas_de_envio .número_do_pedido_de_venda | string | Um número que identifica exclusivamente um documento de vendas. |
|
itens.linhas_de_envio .item_no | string | O número identifica exclusivamente o item no documento de vendas. | Comprimento Máximo:6 |
itens.linhas_de_envio .item_pai_no | string | Apenas V4 O número identifica exclusivamente o item no documento de vendas que é o pai deste item. | Comprimento Máximo:6 |
itens.linhas_de_envio .código_do_produto | string | Código que identifica exclusivamente um produto BRP. | Comprimento Máximo:18 |
itens.linhas_de_envio .descrição_do_produto † | string | Descrição do produto. | Comprimento Máximo:40 |
itens.linhas_de_envio .quantidade_navio | inteiro | A quantidade total do pedido para este item. | |
itens.linhas_de_envio .unidade_de_venda | string | Uma das unidades de medida de vendas da Unidades de Medida tabela. | Comprimento Máximo:3 |
itens.linhas_de_envio .preço_uom | string | Uma das unidades de medida de vendas da Unidades de Medida tabela. | Comprimento Máximo:3 |
itens.linhas_de_envio .unidade_de_medida | string | Unidade de medida na qual o produto é embalado. Uma das unidades de medida de vendas da Unidades de Medida tabela. | Comprimento Máximo: 3 |
itens.linhas_de_envio .em_pacote | objeto | Conteúdo do pacote de vendas. |
|
itens.linhas_de_envio .em_pacote.qty | número
| Número de item(ns) contido(s) na embalagem com base na unidade de medida da embalagem | Precisão: 1.000 |
itens.linhas_de_envio .em_pacote.uom | string | Unidade de medida para o item contido na embalagem. Uma das unidades de medida de vendas da Unidades de Medida tabela. | Comprimento Máximo:3 |
itens.linhas_de_envio .contagem_de_pacotes | número | Número de pacotes enviados | Precisão:1 |
itens.linhas_de_envio .preço_unitário_msrp | número | O preço de venda sugerido pelo fabricante. | Precisão:0.01 |
itens.linhas_de_envio .preço_unitário_atacado | número | Preço unitário por atacado. | Precisão:0.01 |
itens.linhas_de_envio .net_preço_unitário | Número | Preço líquido do item. | Precisão:0.01 |
itens.linhas_de_envio .moeda | String | A moeda usada para expressar o valor do item. Um valor da Moeda tabela. | Comprimento Máximo:5 |
itens.linhas_de_envio .é_produto_substituto | Booleano | Indique se a peça substitui outra peça |
|
itens.linhas_de_envio .código_do_produto_substituído | Booleano | Código do produto substituído. | Comprimento Máximo:18 |
itens.linhas_de_envio .linha_de_produto | String | Linha de produtos à qual este produto está associado. Um valor da Linha de Produtos tabela. |
|
itens.linhas_de_envio .tipo_de_produto | string | Um valor do Ptipo de produto tabela. |
|
itens.linhas_de_envio. planta* | objeto | Informações sobre o envio da planta |
|
Itens.linhas_de_envio. planta.nome | String | Nome da planta. | Comprimento Máximo:40 |
Itens.linhas_de_envio. planta.cidade | String | Endereço da planta / Cidade. | Comprimento Máximo:35 |
Itens.linhas_de_envio. estado.planta | String | Endereço da planta / Estado. | Comprimento Máximo:6 |
Itens.linhas_de_envio. planta.país | String | Endereço da planta / Condado. | Comprimento Máximo:2 |
itens.linhas_de_envio .preços | lista de objetos | Lista de diferentes quantias relacionadas ao documento de vendas do item. |
|
itens.linhas_de_envio .preço.tipo_de_condição | String | Tipo de valor. Um dos :
|
|
itens.linhas_de_envio .preço.total_valor | Número | O valor total é baseado na quantidade do pedido aplicada ao tipo de valor. | Precisão:0.01 |
itens.linhas_de_envio .preços.moeda | String | Um valor da Moeda tabela. | Comprimento Máximo:5 |
itens.linhas_de_envio .entregas | lista de objetos | Informações detalhadas sobre a progressão da entrega por quantidade ao longo do tempo. |
|
itens.linhas_de_envio .entregas .código_de_status | String | Código de status para indicar o estado da quantidade. Um dos:
|
|
itens.linhas_de_envio .entregas.data_status | data e hora | Data e hora para indicar quando o status foi atribuído. | Formato: AAAA-MM-DDTHH:MM:SSZ |
itens.linhas_de_envio .entregas.descricao_status † | string | Informações adicionais relacionadas ao código de status para ser mais preciso quando necessário. | Comprimento Máximo: 50 |
itens.linhas_de_envio .entregas.qtd | número | Quantidade relacionada ao código de status. | Precisão:1.00 |
itens.linhas_de_envio .entregas .data_de_disponibilidade | data | Data de disponibilidade do item. | Formato: AAAA-MM-DD |
itens.linhas_de_envio .entregas.não | string | O número que identifica exclusivamente a entrega.
| Comprimento Máximo:10 |
itens.linhas_de_envio .entregas.numero_item | string | O número que identifica exclusivamente o item em uma entrega.
| Comprimento Máximo:6 |
itens.linhas_de_envio .entregas.quantidade_entrega | inteiro | A quantidade do item para entrega. | |
itens.linhas_de_envio .entregas.data_de_criação | data e hora | Data de criação para a entrega. | Formato: AAAA-MM-DDTHH:MM:SSZ |
itens.linhas_de_envio .entregas.nome_do_transportador | string | Nome da transportadora para a entrega. | Comprimento:40 |
itens.linhas_de_envio .entregas.dividir_numero_entrega | string | O número que identifica exclusivamente a entrega dividida. Consulte os Pedido, Fatura e Entrega: A História Completa páginas para uma explicação sobre as entregas divididas. | Comprimento: 10 |
itens.linhas_de_envio .entregas. dividir_item_de_entrega_número | string | O número que identifica exclusivamente o item em uma entrega dividida. | Comprimento: 6 |
itens.linhas_de_envio .entregas.faturamentos | Lista de objetos | Link do documento de faturamento para a entrega |
|
itens.linhas_de_envio .entregas.faturamentos .número_de_faturamento | string | O número identifica exclusivamente o documento de cobrança. | Comprimento máximo:10 |
itens.linhas_de_envio .entregas.faturamentos .item_de_faturamento | string | O número identifica exclusivamente o item no documento de cobrança. | Comprimento Máximo: 6 |
itens.linhas_de_envio .entregas.faturamentos .data_de_criação_da_fatura | data e hora | Data de criação do documento de faturamento. | Formato: AAAA-MM-DDTHH:MM:SSZ |
itens.linhas_de_envio .entregas.faturamentos .quantidade_faturada | inteiro | A quantidade do item para o documento de faturamento. | |
itens.linhas_de_envio .entregas.faturamentos .está_cancelado | booleano | Indique se o documento de cobrança foi cancelado. |
|
itens.linhas_de_envio .entregas.faturamentos .cancelamento_faturamento_nao | string | O documento de cobrança foi criado para cancelar o documento de cobrança inicial. | Comprimento máximo:10 |
itens.statuses | lista de objetos | Informações de status relacionadas ao documento de vendas do item. |
|
Itens.statuses .tipo | string | O tipo de status indica a gravidade da mensagem para o documento de vendas do item. Um dos:
|
|
itens.statuses .código | string | Código de status relacionado ao documento de vendas do item. Um dos:
|
|
itens.statuses.descr † | string | Texto de status relacionado ao código de status. | Comprimento Máximo:132 |
🛑 Diferenças entre V3 e V4.
Tabelas de Referência
Moeda
Organização de Vendas | Moeda | Versão 3 | Versão 4 |
|---|---|---|---|
1010 | CAD | | X |
3020 | USD | | X |
6030 | EUR | X | |
6030 | NOK | X | |
6050 | SEK | X | |
6050 | EUR | X | |
6050 | GBP | X | |
8070 | MXN | X | |
8075 | BRL | X | |
7080 | AUD | X | |
7080 | NZD | X | |
Linhas de Produtos
Chave | Valor | Marca |
|---|---|---|
2WV | Veículos de duas rodas | Can-Am On-Road |
3WV | Three-wheeled vehicles | Can-Am On-Road |
ATV | All-terrain vehicles | Can-Am Off-Road |
OE | Outboard motors | Sea-Doo |
PTN | Pontoon boats | Sea-Doo |
PWC | Personal Hydroplane Boats | Sea-Doo |
SNO | Snowmobiles | Ski-Doo |
SSV | Vehicles side by side | Can-Am Off-Road |
Tipos de Produtos
Chave | Valor |
|---|---|
10 | Veículo |
20 | Motor |
30 | Partes |
40 | Accessories |
50 | Clothes |
60 | Licenciamento e Jogo |
80 | Manuais |
90 | Trailer |
100 | Reconstructed |
110 | Oil and Chemicals |
NA | When there is no match above (Undefined) |
Métodos de Envio - América do Norte
Código V3 | Código V4 | Descrição | Use |
|---|---|---|---|
01 | S1 | Transporte Terrestre Acelerado | First level update of domestic standard:
|
02 | S2 | Veículo Fora de Serviço | O envio mais rápido disponível. Isso é comumente usado quando os atrasos na entrega são críticos (cenários de veículo parado):
|
03 | S3 | Vehicle Out of Service | Even if the Vehicle Below has the capacity to be received on a Saturday. |
Métodos de Envio - Internacional
Organização de Vendas | Código V3 | Description |
|---|---|---|
6030 - Escandinávia | 50 | itella |
6030 - Escandinávia | 51 | logística de postagem |
6030 - Scandinávia | 52 | earth |
6030 - Escandinávia | 53 | ar |
6030 - Escandinávia | 54 | earth |
6030 - Escandinávia | 55 | ar |
6030 - Escandinávia | 59 | earth |
6030 - Escandinávia | 60 | ar |
6050 - Europa (emea) | 30 | regular |
6050 - Europa (emea) | 33 | press |
7080 - Asia-Pacífico (apac) | 38 | regular |
7080 - Ásia-Pacífico (apac) | 39 | press |
7080 - Ásia-Pacífico (apac) | 40 | regular |
7080 - Ásia-Pacífico (apac) | 82 | estoque |
7080 - Ásia-Pacífico (apac) | 90 | estoque |
8070 - México | 92 | regular |
8070 - México | 93 | ar |
8070 - México | 94 | press |
8075 - Brasil | 63 | carga_aérea_azul |
8075 - Brasil | 77 | sedex_correios |
8075 - Brasil | 78 | road standard |
Unidade de Medidas
Código | Descrição | Dimensão |
|---|---|---|
" | Polegada | Comprimento |
CAIXA | Caixa | Quantidade |
BR | Barril | Quantidade |
BT | Garrafa | Quantidade |
BU | Balde | Quantidade |
PODE | Cilindro | Quantidade |
CC | Centímetro cúbico | Volume |
CDM | Decímetro cúbico | Volume |
CG | Centigramas | Peso |
CL | Centilitros | Volume |
CM | Centímetro | Comprimento |
CS | Caixa | Quantidade |
FT | Pés | Comprimento |
G | Grama | Peso |
GA | Galões | Volume |
GU | Galão Americano | Volume |
H | Hora | Tempo |
KG | Quilograma | Peso |
L | Litro | Volume |
LB | Libra | Peso |
LT | Lote | Quantidade |
M | Medidor | Comprimento |
M2 | Metro quadrado | Área |
MG | Miligrama | Peso |
ML | Mililitro | Volume |
MM | Milímetro | Comprimento |
OZ | Onças | Peso |
P | Pontos | Quantidade |
PAC | Pacote | Quantidade |
PC | Peça | Quantidade |
PR | Par | Quantidade |
PT | Pinturas | Volume |
QT | Quartzos | Volume |
ROL | Rolar | Quantidade |
CONFIGURAR | Conjunto | Quantidade |
SF | Pés Quadrados | Área |
SH | Folhas | Quantidade |
SIM | Polegada Quadrada | Área |
SY | Jarda Quadrada | Área |
TB | Tubo | Quantidade |
YD | Quintal | Comprimento |
HL | Hectolitro | Volume |
M3 | Metro cúbico | Volume |
P3 | Pés cúbicos | Volume |
LM | Metro linear | comprimento |
CM2 | Centímetro quadrado | Superfície |
PO3 | Polegada cúbica | Volume |
DZ | Duzena | Quantidade |
Recurso: Cancelamento de Pedido de Peças
O recurso de Cancelamento de Pedido de Peças é usado para chamar o serviço de Cancelamento.
Representação JSON
{
"pac_order_id": "62e9969d-ee6b-44af-a70f-acc3400df20c",
“dealer_no” : “0000691756”,
"items": [
{
"item_id": "e3afa79f-2953-caf5-858d-842b2b523deb"
}
]
}
Propriedades
Propriedade | Tipo | Definição | Notas |
|---|---|---|---|
pac_order_id * | string | Código que identifica exclusivamente o número do pedido de compra, representado por um GUID | Comprimento Máximo:36 |
número_do_revendedor * | String | Código que identifica exclusivamente um revendedor. Deve ter 10 caracteres. Se tiver menos de 10 caracteres, adicione '0' no início. | Comprimentoh:10 |
itens * | lista de objetos | Estrutura que contém detalhes do item relacionados ao documento de vendas. | |
itens.item_id * | string | Código que identifica exclusivamente o número do item, representado por um GUID. | Comprimento Máximo:36 |
* Esses campos são obrigatórios.
Recurso: Peças em Atraso
Apenas V4
O Obter Pedidos Pendentes serviço retorna o Recurso de Pedido Pendente.
Representação JSON
{
"items": [
{
"sales_order_no": "1030895371",
"dealer_po_no": "ORV ACC 2024 SSU 2",
"order_type": "stocking_order",
"creation_date": "2024-03-14T22:02:41Z",
"items": [
{
"item_no": "008300",
"product_code": "715006112",
"product_descr": "SEAT_HEATED KIT",
"product_type": "40",
"order_qty": 2,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": true,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "008301",
"product_code": "715006112",
"product_descr": "SEAT_HEATED KIT",
"product_type": "40",
"order_qty": 2,
"parent_item_no": "008300",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "",
"qty": 2,
"availability_date": "2025-01-01"
}
]
}
]
},
{
"sales_order_no": "1030895667",
"dealer_po_no": "ORV PARTS COM 2024 SSU 2",
"order_type": "stocking_order",
"creation_date": "2024-03-14T22:59:03Z",
"items": [
{
"item_no": "042200",
"product_code": "706001678",
"product_descr": "SWAY BAR",
"product_type": "30",
"order_qty": 1,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": true,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "042201",
"product_code": "706005447",
"product_descr": "BAR_STABILIZER",
"product_type": "30",
"order_qty": 1,
"parent_item_no": "042200",
"is_sales_bom": false,
"is_substituded_part": true,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "",
"qty": 1,
"availability_date": "2025-01-01"
}
]
},
{
"item_no": "042800",
"product_code": "706003033",
"product_descr": "REAR SHOCK",
"product_type": "30",
"order_qty": 2,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": true,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "042801",
"product_code": "706003033",
"product_descr": "REAR SHOCK",
"product_type": "30",
"order_qty": 2,
"parent_item_no": "042800",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "Contact PAA Support",
"qty": 2,
"availability_date": null
}
]
},
{
"item_no": "045600",
"product_code": "706202764",
"product_descr": "LINK STABILIZER BAR LH",
"product_type": "30",
"order_qty": 4,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": true,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "045601",
"product_code": "706202764",
"product_descr": "LINK STABILIZER BAR LH",
"product_type": "30",
"order_qty": 4,
"parent_item_no": "045600",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "",
"qty": 4,
"availability_date": "2025-01-01"
}
]
},
{
"item_no": "049100",
"product_code": "707001348",
"product_descr": "SHIFTING CABLE",
"product_type": "30",
"order_qty": 2,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": true,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "049101",
"product_code": "707001348",
"product_descr": "SHIFTING CABLE",
"product_type": "30",
"order_qty": 2,
"parent_item_no": "049100",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "",
"qty": 2,
"availability_date": "2025-01-01"
}
]
},
{
"item_no": "050200",
"product_code": "707003185",
"product_descr": "HAND LEVER_ACCELERATOR",
"product_type": "30",
"order_qty": 4,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "050202",
"product_code": "707003185",
"product_descr": "HAND LEVER_ACCELERATOR",
"product_type": "30",
"order_qty": 4,
"parent_item_no": "050200",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "",
"qty": 4,
"availability_date": "2025-01-01"
}
]
},
{
"item_no": "051600",
"product_code": "707800264",
"product_descr": "AIR FILTER",
"product_type": "30",
"order_qty": 3,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": true,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "051601",
"product_code": "707800264",
"product_descr": "AIR FILTER",
"product_type": "30",
"order_qty": 3,
"parent_item_no": "051600",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "",
"qty": 3,
"availability_date": "2025-01-01"
}
]
},
{
"item_no": "058400",
"product_code": "710006134",
"product_descr": "HANDLE SWITCH",
"product_type": "30",
"order_qty": 12,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "058403",
"product_code": "710006134",
"product_descr": "HANDLE SWITCH",
"product_type": "30",
"order_qty": 2,
"parent_item_no": "058400",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "",
"qty": 2,
"availability_date": "2025-01-01"
}
]
},
{
"item_no": "061800",
"product_code": "715900499",
"product_descr": "YOKE",
"product_type": "30",
"order_qty": 8,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "061802",
"product_code": "715900499",
"product_descr": "YOKE",
"product_type": "30",
"order_qty": 2,
"parent_item_no": "061800",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "",
"qty": 2,
"availability_date": "2025-01-01"
}
]
},
{
"item_no": "062600",
"product_code": "715900653",
"product_descr": "HALOGEN BULB H8 12V 35W BLUE",
"product_type": "30",
"order_qty": 6,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": true,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "062601",
"product_code": "715900653",
"product_descr": "HALOGEN BULB H8 12V 35W BLUE",
"product_type": "30",
"order_qty": 6,
"parent_item_no": "062600",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "",
"qty": 6,
"availability_date": "2025-01-01"
}
]
},
{
"item_no": "065500",
"product_code": "709400439",
"product_descr": "BALL BEARING",
"product_type": "30",
"order_qty": 4,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": true,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "065501",
"product_code": "709400439",
"product_descr": "BALL BEARING",
"product_type": "30",
"order_qty": 4,
"parent_item_no": "065500",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "",
"qty": 4,
"availability_date": "2025-01-01"
}
]
}
]
},
{
"sales_order_no": "1030900320",
"dealer_po_no": "ODN030211",
"order_type": "expedited",
"creation_date": "2024-03-18T13:23:15Z",
"items": [
{
"item_no": "001300",
"product_code": "4546631290",
"product_descr": "SEA-DOO SIGNATURE T-SHIRT MEN XL",
"product_type": "50",
"order_qty": 1,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": true,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "001301",
"product_code": "4546631290",
"product_descr": "SEA-DOO SIGNATURE T-SHIRT MEN XL",
"product_type": "50",
"order_qty": 1,
"parent_item_no": "001300",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "Contact PAA Support",
"qty": 1,
"availability_date": null
}
]
}
]
},
{
"sales_order_no": "1030900350",
"dealer_po_no": "ODN030211",
"order_type": "expedited",
"creation_date": "2024-03-18T13:40:57Z",
"items": [
{
"item_no": "008100",
"product_code": "715007727",
"product_descr": "SMART LED CHASE LIGHT",
"product_type": "40",
"order_qty": 3,
"parent_item_no": "000000",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": true,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": []
},
{
"item_no": "008101",
"product_code": "715007727",
"product_descr": "SMART LED CHASE LIGHT",
"product_type": "40",
"order_qty": 3,
"parent_item_no": "008100",
"is_sales_bom": false,
"is_substituded_part": false,
"is_cancellable": false,
"bo_cancel_status": "",
"bo_cancel_message": "",
"item_texts": [],
"delivery_progress": [
{
"status_code": "backorder",
"status_descr": "Contact PAA Support",
"qty": 3,
"availability_date": null
}
]
}
]
}
]
}
Propriedades
Propriedade | Tipo | Definição | Notas |
|---|---|---|---|
número_do_pedido_de_venda | string | O número que identifica exclusivamente o documento de vendas. | Comprimento Máximo:10 |
número_do_pedido_do_revendedor | string | O número que o vendedor usa para identificar exclusivamente o pedido de peças. | Comprimento máximo:35 |
tipo_de_pedido | string | Uma classificação que distingue entre diferentes tipos de documentos de vendas. Um dos:
|
|
data_de_criação | string | Data e hora em que o pedido de venda foi criado. | Formato: AAAA-MM-DDTHH:MM:SSZ |
itens | array de objetos | O objeto de detalhes do item é usado para mostrar os detalhes de cada item relacionado ao pedido de peças. |
|
itens.item_no | string | O número que identifica exclusivamente o item no documento de vendas. | Comprimento Máximo:6 |
itens.código_do_produto | string | Código que identifica exclusivamente um produto BRP. | Comprimento Máximo:18 |
descrição_do_produto.itens | string | Descrição do produto. | Comprimento Máximo:40 |
itens.tipo_de_produto | string | Tipo de Produto |
|
itens.quantidade_pedido | número | A quantidade total solicitada para este item. | Precisão:1.00 |
itens.numero_item_pai | string | O item pai se a peça estiver incluída em um kit. | |
itens.é_venda_bom | booleano | Indique se a peça solicitada é um kit (BOM). | |
itens.é_parte_substituída | booleano | Indique se outra parte substitui a parte. | |
itens.são_canceláveis | booleano | Indica se você tem permissão para cancelar o item. | |
itens.bo_cancel_status
| string | Cancelar status. Um dos seguintes:
|
|
itens.mensagem_cancelamento_bo | string | Mensagem retornada se houver um erro ao cancelar a peça. | Comprimento Máximo:120 |
itens.progresso_de_entrega | Lista de objetos | Informações detalhadas sobre o progresso da entrega por quantidade. |
|
itens.progresso_de_entrega .código_de_status | String | Código de status para indicar o estado da quantidade. Sempre pedido em atraso. |
|
itens.progresso_de_entrega .descrição_status | String | Informações adicionais relacionadas ao código de status para ser mais preciso quando necessário. | Comprimento Máximo: 50 |
itens.progresso_de_entrega .quantidade | Número | Quantidade relacionada ao código de status | Precisão:1.00 |
itens.progresso_de_entrega .quantidade | Número | Quantidade relacionada ao código de status | Precisão:1.00 |
itens.progresso_de_entrega .data_de_disponibilidade | data | Data de disponibilidade do item. | Formato: 2017-11-07 |
itens.progresso_de_entrega .descrição_status† | String | Informações adicionais relacionadas ao código de status para ser mais preciso quando necessário. | Comprimento Máximo: 50 |
itens.item_textos | Lista de objetos | |
|
itens.textos_do_item .código_texto | String | Código identificando o tipo de texto. Sempre campo_memo. |
|
itens.item_textos .texto_descr† | String | Texto aplicado ao código de texto. | Comprimento Máximo:120
|
Limitações e Restrições
Formato de Número
Todos os campos numéricos com decimais usam um ponto (.) como separador decimal. A vírgula (,) é NÃO suportada como separador decimal.
Número de Itens e Tempo Limite
Um pedido pode conter mais de 25 itens; no entanto, um tempo limite ocorrerá se o pedido exceder esse limite. A limitação é causada pelo sistema backend que leva cerca de 2 segundos por item para criar o pedido. A própria API tem um tempo limite de 55 segundos que não pode ser alterado no contexto do BRP.
Isso significa que se o pedido incluir mais de 25 itens, a API de Pedido de Peças retorna um status 504 Gateway Timeout.
Seu DMS deve gerenciar o timeout, conforme explicado na Verifique e Timeouts seção.
O Validar serviço é um pouco mais rápido e aceita pedidos de até 30 itens.
🛑 Se você chamar o Criar serviço com a mesma carga útil de 30 itens, você receberá um timeout, que deve gerenciar. Veja a Verifique e Timeouts seção.
❗❗ Um timeout pode ocorrer mesmo que haja menos de 25 itens no Criar pedido ❗❗
O timeout é causado pelo tempo de processamento do SAP, que excede 55 segundos. Em algumas situações, por exemplo, se algumas peças tiverem uma longa cadeia de supersessão, o processamento pode levar mais de 55 segundos com menos de 25 itens.
👉Seu DMS deve gerenciar timeouts em todas as situações!
Validar e Criar Tamanho da Carga Útil
A API de Pedido de Peças está rodando no APIGee, que tem um tamanho máximo de carga útil de 10 MB.
Veja a seção413 Entidade de Requisição Muito Grande para mais informações sobre como lidar com o código de status 413.
Tempo Limite na Chamada para Obter Pedido
A API de Pedido de Peças fornece o Obter Pedido serviço para recuperar pedidos de peças com base em critérios específicos, como um intervalo de datas.
❗ Em alguns casos, os critérios usados para o Obter Pedido chamada do serviço pode selecionar muitos pedidos de peças, e a API retorna um tempo limite ❗
👉 Seu DMS deve lidar com o tempo limite e exibir uma mensagem de erro que peça ao revendedor para alterar os critérios.
Parceiros na Resposta do Serviço de Verificação
A resposta retornada pelo Check serviço não contém a lista de parceiros.
Modificação do Pedido de Peças
❗ Uma vez que um pedido de peças foi criado com uma chamada para o Criar Pedido serviço, não pode ser modificado ❗
Você não pode adicionar ou remover itens do pedido de peças criado.
A única ação é cancelar um item chamando o Cancelar Linha do Pedido serviço.
Somente um item em backorder ou bloqueado pode ser cancelado se o pedido estiver completo!
Se o estado do pedido for em processo ou pendente, qualquer item pode ser cancelado.