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
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
Body
{ "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 } ] }
URL
HEADER
Authorization | Bearer {{token}} |
---|
BODY
Body
{ "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 } ] }
Status 200 OK
{ "success":true }
Status 400. 401 e 404
{ "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] } }
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
Body
{ "companyDocument": "string", "transactionNumber": 0, "transactionDate": "2020-03-20", "personDocument": "string", "sellerId": 0, "orderNumber": 0, "checkout": "string" }
URL
HEADER
Authorization | Bearer {{token}} |
---|
BODY
Body
{ "companyDocument": "string", "transactionNumber": 0, "transactionDate": "2020-03-20", "personDocument": "string", "sellerId": 0, "orderNumber": 0, "checkout": "string" }
Status 200 OK
{ "success":true, "data": [ { "companyId": 1, "number": 1, "date": "2020-03-16T00:00:00", "personDocument": "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 } ] } ] }
Status 400. 401 e 404
{ "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] } }
Import HTML Content
Visão Geral
Conteúdo das Ferramentas