Histórico da Página

Totvs custom tabs box

tabs	Requisitos,Cadastrar Pré-Venda,Buscar Pré-Venda
ids	requisitos,gerarprevenda,buscarprevenda

Totvs custom tabs box items

default	yes
referencia	requisitos

01. INTRODUÇÃO

Para utilização das APIs de Transação, primeiramente é necessário obter um token de autenticação. Para obtê-lo, basta seguir os procedimentos documentados no link a seguir:

Link para documentação referente a obtenção de token: obter token

Totvs custom tabs box items

default	no
referencia	gerarprevenda

01. INTRODUÇÃO

Requisição que tem a finalidade criar uma transação de pré-venda, com capa e itens.

Link para documentação técnica: gerar pré-venda

02. UTILIZAÇÃO

Totvs custom tabs box

tabs	Envio, Retorno
ids	envio,retorno

Totvs custom tabs box items

default	yes
referencia	envio

Totvs custom tabs box

tabs	URL, Body, Exemplo de Requisição
ids	urlE,corpoE,exE

Totvs custom tabs box items

default	yes
referencia	urlE

Button

Cor	#61affe
Texto	POST
Link	.

https://www30.bhan.com.br:9443/transaction/v2/create-pre-sale

Totvs custom tabs box items

default	no
referencia	corpoE

Bloco de código

language	xml
theme	RDark
firstline	1
title	Body
linenumbers	true

{
  "personDocument": "string",
  "companyDocument": "string",
  "movementDate": "2020-03-05T18:09:54.957Z",
  "operationId": 0,
  "sellerId": 0,
  "orderNumber": 0,
  "checkout": "string",
  "items": [
    {
      "productCode": "string",
      "productDescription": "string",
      "grossTotalValue": 0,
      "discountTotalValue": 0,
      "discounItemValue": 0,
      "netTotalValue": 0,
      "requestedQuantity": 0
    }
  ]
}

Totvs custom tabs box items

default	no
referencia	exE

URL

Button

Cor	#61affe
Texto	POST
Link	.

https://www30.bhan.com.br:9443/transaction/v2/create-pre-sale

HEADER

Authorization	Bearer {{token}}

BODY

Bloco de código

language	xml
theme	RDark
firstline	1
title	Body
linenumbers	true

{
  "personDocument": "string",
  "companyDocument": "string",
  "movementDate": "2020-03-05T18:09:54.957Z",
  "operationId": 0,
  "sellerId": 0,
  "orderNumber": 0,
  "checkout": "string",
  "items": [
    {
      "productCode": "string",
      "productDescription": "string",
      "grossTotalValue": 0,
      "discountTotalValue": 0,
      "discounItemValue": 0,
      "netTotalValue": 0,
      "requestedQuantity": 0
    }
  ]
}

Totvs custom tabs box items

default	no
referencia	retorno

Totvs custom tabs box

tabs	Sucesso, Erro
ids	sucesso,erro

Totvs custom tabs box items

default	yes
referencia	sucesso

Bloco de código

language	xml
theme	RDark
firstline	1
title	Status 200 OK
linenumbers	true

{
    "success":true
}

Totvs custom tabs box items

default	no
referencia	erro

Bloco de código

language	xml
theme	RDark
firstline	1
title	Status 400. 401 e 404
linenumbers	true

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": {status code},
    "traceId": {traceId},
    "errors": {
        [lista de erros]
    }
}

Totvs custom tabs box items

default	no
referencia	buscarprevenda

01. INTRODUÇÃO

Requisição que tem a finalidade buscar uma lista de transações de pré-venda, com capa e itens.

Link para documentação técnica: Buscar pré-venda

02. UTILIZAÇÃO

Totvs custom tabs box

tabs	Envio, Retorno
ids	envio2,retorno2

Totvs custom tabs box items

default	yes
referencia	envio2

Totvs custom tabs box

tabs	URL, Body, Exemplo de Requisição
ids	urlE2,corpoE2,exE2

Totvs custom tabs box items

default	yes
referencia	urlE2

Button

Cor	#61affe
Texto	POST
Link	.

https://www30.bhan.com.br:9443/transaction/v2/search-pre-sale

Totvs custom tabs box items

default	no
referencia	corpoE2

Bloco de código

language	xml
theme	RDark
firstline	1
title	Body
linenumbers	true

{
  "companyDocument": "string",
  "transactionNumber": 0,
  "transactionDate": "2020-03-20",
  "personDocument": "string",
  "sellerId": 0,
  "orderNumber": 0,
  "checkout": "string"
}

Totvs custom tabs box items

default	no
referencia	exE2

URL

Button

Cor	#61affe
Texto	POST
Link	.

https://www30.bhan.com.br:9443/transaction/v2/search-pre-sale

HEADER

Authorization	Bearer {{token}}

BODY

Bloco de código

language	xml
theme	RDark
firstline	1
title	Body
linenumbers	true

{
  "companyDocument": "string",
  "transactionNumber": 0,
  "transactionDate": "2020-03-20",
  "personDocument": "string",
  "sellerId": 0,
  "orderNumber": 0,
  "checkout": "string"
}

Totvs custom tabs box items

default	no
referencia	retorno2

Totvs custom tabs box

tabs	Sucesso, Erro
ids	sucesso2,erro2

Totvs custom tabs box items

default	yes
referencia	sucesso2

Bloco de código

language	xml
theme	RDark
firstline	1
title	Status 200 OK
linenumbers	true

{
    "success":true,
    "data": [
        {
            "companyId": 1,
            "number": 1,
            "date": "2020-03-16T00:00:00",
            "personIdpersonDocument": 100000002"11122233344",
            "operationId": 6595,
            "paymentTermsId": 1,
            "settlementCompanyId": 1,
            "companyGroupId": 1,
            "situationType": 1,
            "originType": "1",
            "addressSequential": 1,
            "sellerId": 10,
            "operationType": "S",
            "discountPercentage": null,
            "transactionValue": null,
            "discountValue": null,
            "totalValue": null,
            "additionalTransactionInfo": {
                "preSaleNumber": 49,
                "orderNumber": 2,
                "checkout": "f7980a87-6e19-4241-a799-d9f7fca7ca0e"
            },
            "items": [
                {
                    "number": 1,
                    "companyGroupId": 1,
                    "productCode": "123456",
                    "productId": 118252,
                    "productDescription": "ITEM3 CAMISA 151611 RSA UN",
                    "settlementCompanyId": 1,
                    "specieId": null,
                    "sellerId": 10,
                    "grossTotalValue": 100,
                    "discountTotalValue": 10,
                    "discountItemValue": 0,
                    "netTotalValue": 95,
                    "requestedQuantity": 1,
                    "satisfiedQuantity": 0,
                    "balance": 1,
                    "unitaryGrossTotalValue": 100,
                    "unitaryDiscountTotalValue": 10,
                    "unitaryDiscounItemValue": 0,
                    "unitaryNetTotalValue": 95,
                    "discountPercentage": 0.1
                }
            ]
        }
    ]
}

Totvs custom tabs box items

default	no
referencia	erro2

Bloco de código

language	xml
theme	RDark
firstline	1
title	Status 400. 401 e 404
linenumbers	true

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": {status code},
    "traceId": {traceId},
    "errors": {
        [lista de erros]
    }
}

Páginas filhas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

01. INTRODUÇÃO

Para utilização das APIs de Transação, primeiramente é necessário obter um token de autenticação. Para obtê-lo, basta seguir os procedimentos documentados no link a seguir:

01. INTRODUÇÃO

02. UTILIZAÇÃO

01. INTRODUÇÃO

02. UTILIZAÇÃO