GoDeep - Documentação
HomeB2BB2CHUBAplicativoAPIs
HomeB2BB2CHUBAplicativoAPIs
  1. PEDIDOS
  • GoDeep
    • Quem Somos
    • Meios de pagamento - B2C
  • ERPs
    • Integração Sankhya
    • ERPs integrados com a GoDeep
  • Documentação Funcional
    • Deep B2B
      • Fretes
      • Configurações gerais
      • Promoções
        • Cupons de Desconto
      • Pedidos
        • Cobrança de taxa em cima do valor do pedido
      • Meios de Pagamento
        • Itaú
    • Deep B2C
      • Produtos
        • Marcas
        • Seletor Mix
        • Importador manual de listas de preço
      • Pedidos
        • Pedidos - Status
        • Endpoint Compras por WhatsApp
      • Fretes
        • Fretes
        • Correios
        • Data Frete
        • Dedalog
        • Frenet
        • Melhor Envio
        • TransPaulo
        • Total Express
        • Intelipost
        • Jadlog
        • Jamef
      • Meios de Pagamento
        • Itaú
      • Promoções
        • Cupons de Desconto
      • Institucionais
        • Páginas institucionais
      • Configurações gerais
        • Importação manual de produtos
    • Deep HUB
      • Marketplaces
        • Marketplace F1
        • Amazon
        • Mercado Livre
      • Configurações gerais
        • Erro ao criar produto no Mercado Livre – B2C
    • Deep Sales
      • Aplicativo Deep Sales
  • APIs
    • Deep B2B
      • Produtos
        • Informações sobre o endpoint
        • cadastrar produtos e relacionamentos (completo)
        • cadastrar produto
        • cadastrar produto kit
        • cadastrar produto com garantia extendida
        • atualizar produto
        • atualizar estoque do produto
        • atualizar listas de preço do produto
        • listar produtos
        • listar identificadores dos produtos
        • obter produto
        • listagem simples (codigo produto e dados de estoque)
      • Produtos Relacionados
        • obter produtos relacionados
        • obter produtos similares
        • obter produtos complementares
        • cadastrar produtos similares
        • cadastrar produtos complementares
        • cadastrar produtos relacionados
      • PRODUTOS CONCEITOS
        • cadastrar conceito
        • atualizar conceito
        • listar conceitos
        • obter conceito
      • PRODUTOS PREÇO
        • Informações sobre o endpoint
        • cadastrar preco para um produto existente
        • atualizar preco de um produto existente
        • listar precos de um produto existente
        • obter o preco de um produto existente por segmentacao
        • atualizar precos por lista de preco
        • consultar processos de atualizacao de lista
      • PRODUTOS ESTOQUE
        • cadastrar estoque para um produto existente
        • atualizar estoque de um produto existente
        • deletar o estoque de um produto existente por segmentacao (Não Usar)
        • listar os estoques de um produto existente
        • obter o estoque de um produto existente por segmentacao
      • PRODUTOS ATRIBUTOS
        • cadastrar atributo
        • atualizar atributo
        • deletar atributo (Não Usar)
        • deletar atributo de uma classe existente (Não Usar)
        • listar atributos
        • obter atributo
      • PRODUTOS VALORES DE ATRIBUTOS
        • cadastrar valor de atributo para um produto existente
        • cadastrar multiplos atributos para um produto existente
        • cadastrar multiplos valores para um atributo especifico e um produto existente
        • atualizar valor de atributo de um produto existente
        • deletar o valor do atributo de um produto existente (Não Usar)
      • PRODUTOS CATEGORIA
        • cadastrar categoria
        • cadastrar vinculo cliente e categoria
        • atualizar categoria
        • deletar categoria (Não Usar)
        • listar categorias
        • obter categoria
      • PRODUTOS CLASSE
        • cadastrar classe
        • cadastrar classe com classe pai
        • cadastrar atributo para uma classe existente
        • cadastrar multiplos atributos para uma classe existente
        • atualizar classe
        • deletar classe (Não Usar)
        • listar classes
        • obter classe
      • PRODUTOS RESERVA DE ESTOQUE
        • consultar reservas de estoque
      • IMPOSTOS REGIME TRIBUTÁRIO
        • cadastrar regime tributario
        • atualizar regime tributario
        • deletar regime tributario (Não Usar)
        • listar regime tributario
        • obter regime tributario
      • IMPOSTOS MATRIZ TRIBUTÁRIA
        • Informações sobre o endpoint
        • cadastrar ou atualizar matriz tributaria
        • listar matriz tributaria
        • obter matriz tributaria
      • IMPOSTOS (IPI) MATRIZ TRIBUTÁRIA DE IPI
        • cadastrar matriz tributaria IPI
        • listar matriz tributaria IPI
        • obter matriz tributaria IPI
      • VENDEDORES / REPRESENTANTES
        • Informações sobre o endpoint
        • cadastar vendedores
        • atualizar vendedores
        • listar vendedores
        • obter vendedores
        • remover vendedor (Não Usar)
      • CARTEIRAS
        • Informações sobre o endpoint
        • cadastrar carteira
        • atualizar carteira
        • obter carteira
        • listar carteiras
        • remover carteira (Não Usar)
      • CLIENTES
        • Informações sobre o endpoint
        • cadastrar cliente
        • atualizar cliente
        • obter cliente
        • listar cliente
        • remover cliente (Não Usar)
      • CLIENTES SEGMENTOS
        • listar segmentos
        • obter segmento
        • cadastrar segmentos
        • atualizar segmentos
      • CLIENTES CONTATOS
        • listar crm contatos
        • cadastrar crm contatos
        • obter crm contatos
        • atualizar crm contatos
        • remover crm contato (Não Usar)
      • PEDIDOS
        • listar pedidos
          GET
        • obter pedido
          GET
        • atualizar pedido
          PUT
        • atualizar pedido com cancelamento parcial de itens
          PUT
      • PEDIDOS NOTAS
        • Informações sobre o endpoint de notas
        • cadastrar notas
        • listar notas
        • obter nota
        • atualizar nota
        • remover nota (Não Usar)
      • CHECAGEM DE EXISTÊNCIA
        • CRM
        • not existing data entities
      • ARQUIVOS
        • cadastrar arquivo
      • DESCONTO PROGRESSIVO
        • listar
        • obter
        • atualizar
        • cadastrar
        • remover (Não Usar)
      • RELATÓRIOS COMISSÕES
        • Informações sobre o endpoint de comissões
        • Listar Comissões
        • Cadastrar
      • CONDIÇÕES DE PAGAMENTO
        • Informações sobre o endpoint de condições de pagamento
        • listar
        • obter
        • cadastrar
        • atualizar
        • remover (Não Usar)
      • PEDIDOS EXTERNOS
        • cadastrar
        • atualizar
        • obter
      • CONSULTA PRODUTOS (LOJA)
        • Informações sobre o endpoint de consulta de produtos na loja
        • Consulta Produtos Geral
        • Consulta Produtos por Código
  1. PEDIDOS

obter pedido

GET
http://apidatain-prod.f1ws.com.br/orders/76407
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://apidatain-prod.f1ws.com.br/orders/76407' \
--header 'Content-Type: application/json' \
--data-raw '{}'
Response Response Example
{
    "id": 13970,
    "code": "001",
    "f1_id": 452,
    "enterprise_id": 13,
    "name_corporate": "EMP",
    "name_fancy": "EMP",
    "cnpj": "00000000000000",
    "registration_state": "0000000000",
    "email": "[email protected]",
    "client_code": "001",
    "representative_name": "EMP",
    "representative_email": "[email protected]",
    "representative_phone": "9999999999",
    "representative_birth_date": "1901-01-01",
    "representative_cpf": "00000000000000",
    "representative_cell_phone": "9999999999",
    "representative_office": "",
    "order_type": "REVENDA",
    "order_sequencial_number": 190,
    "user_id": "0000000001",
    "user_code": "0000000001",
    "tele_sales_user_code": "0000000000",
    "link": "0",
    "origin_ip": "0.0.0.0",
    "phone": "9999999999",
    "order_date": "2023-01-31 15:06:03",
    "delivery_date": "2023-02-14 15:06:03",
    "exportation_date": "1901-01-01 00:00:00",
    "status": "FATURADO",
    "status_id": "FATURADO",
    "status_message": null,
    "external_status_id": "FATURADO",
    "modification_date": "2023-02-01 03:00:22",
    "partial_billing": 0,
    "order_total_value": "88.44",
    "order_total_st": "0.00",
    "order_total_ipi": "5.40",
    "order_total_discounts": "51.24",
    "order_freight": "0.00",
    "client_comment": "",
    "client_segment_external_code": "5442",
    "tax_discount": "0.00",
    "purchase_order": "0",
    "approved_date": null,
    "total_extended_warranty": "0.00",
    "responsible_order_user_id": 28,
    "responsible_order_user_type": "Vendedor",
    "responsible_order_user_name": "Vendedor Teste",
    "responsible_order_user_mail": "[email protected]",
    "responsible_order_user_external_code": "0000000000",
    "responsible_order_user_cellphone": null,
    "responsible_order_client_external_code": null,
    "responsible_order_user_code": null,
    "responsible_order_user_cnpj": null,
    "invoice_message": "Teste",
    "billing_date": null,
    "receive_delivery_information": 0,
    "sub_external_code": null,
    "reservation_id": null,
    "created_at": "2023-01-31 15:08:33",
    "updated_at": "2023-02-01 15:05:20",
    "deleted_at": null,
    "updated_for": "EXTERNAL",
    "addresses": [
        {
            "number": "1",
            "id": 27948,
            "order_id": 13970,
            "type": "Entrega",
            "state": "RS",
            "city": "CIDADE",
            "neighborhood": "CENTRO",
            "street": "RUA",
            "complement": "",
            "zipcode": "00000000",
            "created_at": "2023-01-31 15:08:33",
            "updated_at": "2023-01-31 15:08:33",
            "deleted_at": null
        },
        {
            "number": "1",
            "id": 27949,
            "order_id": 13970,
            "type": "Cobranca",
            "state": "RS",
            "city": "CIDADE",
            "neighborhood": "CENTRO",
            "street": "RUA",
            "complement": "",
            "zipcode": "00000000",
            "created_at": "2023-01-31 15:08:33",
            "updated_at": "2023-01-31 15:08:33",
            "deleted_at": null
        }
    ],
    "distribution_centers": [
        {
            "id": 13962,
            "order_id": 13970,
            "identification": "IDENTIFICADOR",
            "freight": "0.00",
            "freight_original_value": "0.00",
            "freight_discount": "0.00",
            "freight_delivery_time": "10",
            "freight_name": "NOME",
            "freight_id": "0300",
            "freight_id_transport": null,
            "transport_cnpj": "",
            "transport_modality": "",
            "classification": "CIF",
            "code": "0300",
            "state": "RS",
            "invoice_message": "",
            "created_at": "2023-01-31 15:08:33",
            "updated_at": "2023-01-31 15:08:33",
            "deleted_at": null
        }
    ],
    "payments": [
        {
            "id": 13959,
            "order_id": 13970,
            "external_code": "0003",
            "value": "88.44",
            "discount": "0.00",
            "discount_total": "51.24",
            "fees": "0.00",
            "comments": "",
            "type": "Visa",
            "installments_qty": 1,
            "installment": "1x R$ 88,44",
            "internal_type": "card",
            "created_at": "2023-01-31 15:08:33",
            "updated_at": "2023-01-31 15:08:33",
            "deleted_at": null
        }
    ],
    "payments_providers": [
        {
            "id": 81,
            "order_id": 13970,
            "message": "success",
            "tid": "",
            "nsu": "",
            "capture_nsu": "",
            "authorization_code": "",
            "payment_id": "",
            "receive_date": "2023-01-31 15:06:05",
            "provider": "Rede",
            "installments": 1,
            "proof_of_sale": "",
            "card_number": "",
            "card_bin": "",
            "card_end": "",
            "created_at": "2023-01-31 15:08:33",
            "updated_at": "2023-01-31 15:08:33",
            "deleted_at": null
        }
    ],
    "items": [
        {
            "id": 42316,
            "order_id": 13970,
            "order_distribution_center_id": 13962,
            "product_id": 1,
            "product_code": "685",
            "product_name": "Teste",
            "product_integrated_value_of": "0.00",
            "product_integrated_value_for": "0.00",
            "product_value": "7.37",
            "nature_operation": "*",
            "product_gross_value": "11.19",
            "product_with_discount": "6.92",
            "qty": "12.00",
            "total_value": "88.44",
            "discount": "0.00",
            "unitary_custom_discount_value": "0",
            "total_custom_discount_value": "0.00",
            "custom_discount_percent": "0.00",
            "unitary_discount_payment_value": "0.00",
            "total_discount_payment_value": "0.00",
            "unitary_interest_payment_value": "0.00",
            "total_interest_payment_value": "0.00",
            "unitary_discount_segment_value": "4.27",
            "total_discount_segment_value": "51.25",
            "segment_discount_percent": "38.17",
            "unitary_product_value_with_ipi": "7.37",
            "total_product_value_with_ipi": "88.44",
            "unitary_product_value_with_icms": "7.37",
            "total_product_value_with_icms": "88.44",
            "product_without_payment_condition": "11.19",
            "product_value_without_payment_condition": "7.37",
            "product_total_without_payment_condition": "88.44",
            "unitary_product_freight_value": "0.00",
            "total_product_freight_value": "0.00",
            "unitary_product_freight_value_without_payment_condition": "0.00",
            "total_product_freight_value_without_payment_condition": "0.00",
            "unitary_st_value": "0.00",
            "total_st_value": "0.00",
            "unitary_ipi_value": "0.45",
            "total_ipi_value": "5.40",
            "unitary_icms_value": "0.00",
            "total_icms_value": "0.00",
            "reduced_icms": "0.00",
            "price_list_id": 155,
            "price_list_code": "RW",
            "ipi_aliq": "6.50",
            "st_aliq": "0.00",
            "fcp_aliq": "0.00",
            "extended_warranty_code": "",
            "extended_warranty_value": "0.00",
            "extended_warranty_unitary_without_payment_condition": "0.00",
            "extended_warranty_total_without_payment_condition": "0.00",
            "extended_warranty_total": "0.00",
            "price_final_sale": "0",
            "unitary_icms_discount": "0.00",
            "quantity_canceled": 0,
            "order_item_status": null,
            "message": null,
            "progressive_discount_coupon": "0.00",
            "updated_for": "APISYNC",
            "created_at": "2023-01-31 15:08:33",
            "updated_at": "2023-01-31 15:08:33",
            "deleted_at": null,
            "direct_billing_product_unitary_value": null,
            "direct_billing_product_total_value": null,
            "direct_billing_product_unitary_commission": null,
            "direct_billing_product_total_commission": null,
            "sequential": 1,
            "external_item_id": null,
            "code_kit": "",
            "principal_kit": 0,
            "unitary_product_overprice": "0.00",
            "unitary_product_overprice_without_payment_condition": "0.00"
        }
    ],
    "invoices": [
        {
            "id": 23,
            "order_id": 13970,
            "order_external_id": null,
            "type": "SALE",
            "distribution_center_code": "001",
            "number": "0001",
            "serie": null,
            "key": null,
            "invoice_date": "2023-02-01 00:00:00",
            "tracking_code": null,
            "tracking_url": null,
            "transport_code": null,
            "transport_name": null,
            "delivery_date": null,
            "billing_type": null,
            "code": "0001",
            "issued": null,
            "base64_file": null,
            "to_delete": 0,
            "created_at": "2023-02-01 15:00:16",
            "updated_at": "2023-02-01 15:00:16",
            "deleted_at": null
        }
    ]
}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header
Content-Type
string 
requerido
Exemplo:
application/json
Parâmetros Bodyapplication/json
object {0}
Examples

Respostas

🟢200obter pedido
application/json
Body
id
integer 
requerido
code
string 
requerido
f1_id
integer 
requerido
enterprise_id
integer 
requerido
name_corporate
string 
requerido
name_fancy
string 
requerido
cnpj
string 
requerido
registration_state
string 
requerido
email
string 
requerido
client_code
string 
requerido
representative_name
string 
requerido
representative_email
string 
requerido
representative_phone
string 
requerido
representative_birth_date
string 
requerido
representative_cpf
string 
requerido
representative_cell_phone
string 
requerido
representative_office
string 
requerido
order_type
string 
requerido
order_sequencial_number
integer 
requerido
user_id
string 
requerido
user_code
string 
requerido
tele_sales_user_code
string 
requerido
link
string 
requerido
origin_ip
string 
requerido
phone
string 
requerido
order_date
string 
requerido
delivery_date
string 
requerido
exportation_date
string 
requerido
status
string 
requerido
status_id
string 
requerido
status_message
null 
requerido
external_status_id
string 
requerido
modification_date
string 
requerido
partial_billing
integer 
requerido
order_total_value
string 
requerido
order_total_st
string 
requerido
order_total_ipi
string 
requerido
order_total_discounts
string 
requerido
order_freight
string 
requerido
client_comment
string 
requerido
client_segment_external_code
string 
requerido
tax_discount
string 
requerido
purchase_order
string 
requerido
approved_date
null 
requerido
total_extended_warranty
string 
requerido
responsible_order_user_id
integer 
requerido
responsible_order_user_type
string 
requerido
responsible_order_user_name
string 
requerido
responsible_order_user_mail
string 
requerido
responsible_order_user_external_code
string 
requerido
responsible_order_user_cellphone
null 
requerido
responsible_order_client_external_code
null 
requerido
responsible_order_user_code
null 
requerido
responsible_order_user_cnpj
null 
requerido
invoice_message
string 
requerido
billing_date
null 
requerido
receive_delivery_information
integer 
requerido
sub_external_code
null 
requerido
reservation_id
null 
requerido
created_at
string 
requerido
updated_at
string 
requerido
deleted_at
null 
requerido
updated_for
string 
requerido
addresses
array [object {13}] 
requerido
number
string 
requerido
id
integer 
requerido
order_id
integer 
requerido
type
string 
requerido
state
string 
requerido
city
string 
requerido
neighborhood
string 
requerido
street
string 
requerido
complement
string 
requerido
zipcode
string 
requerido
created_at
string 
requerido
updated_at
string 
requerido
deleted_at
null 
requerido
distribution_centers
array [object {19}] 
requerido
id
integer 
opcional
order_id
integer 
opcional
identification
string 
opcional
freight
string 
opcional
freight_original_value
string 
opcional
freight_discount
string 
opcional
freight_delivery_time
string 
opcional
freight_name
string 
opcional
freight_id
string 
opcional
freight_id_transport
null 
opcional
transport_cnpj
string 
opcional
transport_modality
string 
opcional
classification
string 
opcional
code
string 
opcional
state
string 
opcional
invoice_message
string 
opcional
created_at
string 
opcional
updated_at
string 
opcional
deleted_at
null 
opcional
payments
array [object {15}] 
requerido
id
integer 
opcional
order_id
integer 
opcional
external_code
string 
opcional
value
string 
opcional
discount
string 
opcional
discount_total
string 
opcional
fees
string 
opcional
comments
string 
opcional
type
string 
opcional
installments_qty
integer 
opcional
installment
string 
opcional
internal_type
string 
opcional
created_at
string 
opcional
updated_at
string 
opcional
deleted_at
null 
opcional
payments_providers
array [object {18}] 
requerido
id
integer 
opcional
order_id
integer 
opcional
message
string 
opcional
tid
string 
opcional
nsu
string 
opcional
capture_nsu
string 
opcional
authorization_code
string 
opcional
payment_id
string 
opcional
receive_date
string 
opcional
provider
string 
opcional
installments
integer 
opcional
proof_of_sale
string 
opcional
card_number
string 
opcional
card_bin
string 
opcional
card_end
string 
opcional
created_at
string 
opcional
updated_at
string 
opcional
deleted_at
null 
opcional
items
array [object {73}] 
requerido
id
integer 
opcional
order_id
integer 
opcional
order_distribution_center_id
integer 
opcional
product_id
integer 
opcional
product_code
string 
opcional
product_name
string 
opcional
product_integrated_value_of
string 
opcional
product_integrated_value_for
string 
opcional
product_value
string 
opcional
nature_operation
string 
opcional
product_gross_value
string 
opcional
product_with_discount
string 
opcional
qty
string 
opcional
total_value
string 
opcional
discount
string 
opcional
unitary_custom_discount_value
string 
opcional
total_custom_discount_value
string 
opcional
custom_discount_percent
string 
opcional
unitary_discount_payment_value
string 
opcional
total_discount_payment_value
string 
opcional
unitary_interest_payment_value
string 
opcional
total_interest_payment_value
string 
opcional
unitary_discount_segment_value
string 
opcional
total_discount_segment_value
string 
opcional
segment_discount_percent
string 
opcional
unitary_product_value_with_ipi
string 
opcional
total_product_value_with_ipi
string 
opcional
unitary_product_value_with_icms
string 
opcional
total_product_value_with_icms
string 
opcional
product_without_payment_condition
string 
opcional
product_value_without_payment_condition
string 
opcional
product_total_without_payment_condition
string 
opcional
unitary_product_freight_value
string 
opcional
total_product_freight_value
string 
opcional
unitary_product_freight_value_without_payment_condition
string 
opcional
total_product_freight_value_without_payment_condition
string 
opcional
unitary_st_value
string 
opcional
total_st_value
string 
opcional
unitary_ipi_value
string 
opcional
total_ipi_value
string 
opcional
unitary_icms_value
string 
opcional
total_icms_value
string 
opcional
reduced_icms
string 
opcional
price_list_id
integer 
opcional
price_list_code
string 
opcional
ipi_aliq
string 
opcional
st_aliq
string 
opcional
fcp_aliq
string 
opcional
extended_warranty_code
string 
opcional
extended_warranty_value
string 
opcional
extended_warranty_unitary_without_payment_condition
string 
opcional
extended_warranty_total_without_payment_condition
string 
opcional
extended_warranty_total
string 
opcional
price_final_sale
string 
opcional
unitary_icms_discount
string 
opcional
quantity_canceled
integer 
opcional
order_item_status
null 
opcional
message
null 
opcional
progressive_discount_coupon
string 
opcional
updated_for
string 
opcional
created_at
string 
opcional
updated_at
string 
opcional
deleted_at
null 
opcional
direct_billing_product_unitary_value
null 
opcional
direct_billing_product_total_value
null 
opcional
direct_billing_product_unitary_commission
null 
opcional
direct_billing_product_total_commission
null 
opcional
sequential
integer 
opcional
external_item_id
null 
opcional
code_kit
string 
opcional
principal_kit
integer 
opcional
unitary_product_overprice
string 
opcional
unitary_product_overprice_without_payment_condition
string 
opcional
invoices
array [object {22}] 
requerido
id
integer 
opcional
order_id
integer 
opcional
order_external_id
null 
opcional
type
string 
opcional
distribution_center_code
string 
opcional
number
string 
opcional
serie
null 
opcional
key
null 
opcional
invoice_date
string 
opcional
tracking_code
null 
opcional
tracking_url
null 
opcional
transport_code
null 
opcional
transport_name
null 
opcional
delivery_date
null 
opcional
billing_type
null 
opcional
code
string 
opcional
issued
null 
opcional
base64_file
null 
opcional
to_delete
integer 
opcional
created_at
string 
opcional
updated_at
string 
opcional
deleted_at
null 
opcional
Modificado em 2025-06-23 20:17:41
Página anterior
listar pedidos
Próxima página
atualizar pedido
Built with