Total - Total Garantido - Application (Novas regras para ofertas garantidas)

Autenticação do Token

Todas as requisições submetidas à nossa API devem ser realizadas através de um token de 2048 caracteres.

O token é gerado através de um usuário e senha que deve ser fornecido pela ClearSale.

Entre em contato com o seu consultor de vendas para maiores informações.

Na autenticação, além do token retornamos sua data de expiração. É necessário que contemple no seu desenvolvimento o gerenciamento da vida útil do token com base nessa data de expiração.

Para o recebimento desse dado é necessário que reserve um espaço de 2048 caracteres. Só gere um novo token após a expiração do seu token atual.

Requisição

POST https://api.clearsale.com.br/v1/authenticate HTTP/1.1
Content-Type: application/json

{
    "name": "{Your User}",
    "password": "{Your Password}"
}

POST https://homologacao.clearsale.com.br/api/v1/authenticate HTTP/1.1
Content-Type: application/json

{
    "name": "{Your User}",
    "password": "{Your Password}"
}

Resposta

            HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Token": "{Token value}",
  "ExpirationDate": "{Token expiration date}"
}     
        

Inclusão de Pedidos

Requisição

POST https://api.clearsale.com.br/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
	"code": "ORDER_EXAMPLE_2_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59.9894222",
	"email": "email@email.com.br",
	"b2bB2c": "B2C",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"numberOfInstallments": 1,
	"ip": "192.168.0.1",
	"isGift": false,
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"channelID": "Additional origin information",
	"reservationDate": "2017-03-21T22:36:36.0000000",
	"country": "Brasil",
	"nationality": "Brasileiro",
	"product": 1,
	"customSla": 60,
	"bankAuthentication": "Aprovado 3DS",
	"subAcquirer": "Sub Acquirer Name",
	"list": {
		"typeID": 3,
		"id": "List Code Example"
	},
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@pemail.com.br",
		"login": "SocialNetworkLogin"
	},
	"socialNetwork": {
		"optInCompreConfie": 1,
		"typeSocialNetwork": 2,
		"authenticationToken": "123456abcd"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		]
	},
	"shipping": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		],
		"deliveryType": "1",
		"deliveryTime": "2 dias úteis",
		"price": 5.00,
		"pickUpStoreDocument": "12345678910"
	},
	"payments": [{
			"sequential": 1,
			"date": "2017-03-21T22:36:53.0000000",
			"value": 25.00,
			"type": 1,
			"installments": 1,
			"interestRate": 10,
			"interestValue": 2.00,
			"currency": 986,
			"voucherOrderOrigin": "123456",
			"card": {
				"number": "123456xxxxxx1234",
				"hash": "12345678945612301234569874563210",
				"bin": "123456",
				"end": "1234",
				"type": 1,
				"validityDate": "02/2021",
				"ownerName": "Owner Card Name",
				"document": "12345678910",
				"nsu": "12345"
			},
			"address": {
				"street": "Street name example",
				"number": "10",
				"additionalInformation": "Additional information example",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"zipcode": "12345678",
				"country": "Brasil",
				"reference": "Address reference example"
			}
		}
	],
	"items": [{
			"code": "Item Code",
			"name": "Item description",
			"barCode": "1234567891012",
			"value": 10.00,
			"amount": 1,
			"categoryID": 1,
			"categoryName": "Item category name",
			"isGift": true,
			"sellerName": "Seller Name",
			"sellerDocument": "12345678910123",
			"isMarketPlace": "true",
			"sellerSegment": "Eletronicos",
			"shippingCompany": "Shipping Company Name"
		}
	],
	"passengers": [{
			"name": "Passanger name",
			"companyMileCard": "Company Name",
			"mileCard": "123456789",
			"identificationType": 1,
			"identificationNumber": "123456789",
			"gender": "M",
			"birthdate": "1990-01-10T00:00:00.000",
			"cpf": "12345678910"
		}
	],
	"connections": [{
			"company": "JJ",
			"identificationNumber": 12345,
			"date": "2017-10-10T00:00:00.000",
			"seatClass": "Seat Class",
			"origin": "GRU",
			"destination": "LHR",
			"boarding": "2017-10-10T00:00:00.000",
			"arriving": "2017-10-10T00:00:00.000",
			"fareClass": "First Class"
		}
	],
	"hotels": [{
			"name": "Hotel Name",
			"city": "Hotel City",
			"state": "Hotel State",
			"country": "Hotel Country",
			"reservationDate": "2017-10-10T00:00:00.000",
			"reserveExpirationDate": "2017-10-10T00:00:00.000",
			"checkInDate": "2017-10-10T00:00:00.000",
			"checkOutDate": "2017-10-10T00:00:00.000"
		}
	]
}

POST https://homologacao.clearsale.com.br/api/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
	"code": "ORDER_EXAMPLE_2_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59.9894222",
	"email": "email@email.com.br",
	"b2bB2c": "B2C",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"numberOfInstallments": 1,
	"ip": "192.168.0.1",
	"isGift": false,
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"channelID": "Additional origin information",
	"reservationDate": "2017-03-21T22:36:36.0000000",
	"country": "Brasil",
	"nationality": "Brasileiro",
	"product": 1,
	"customSla": 60,
	"bankAuthentication": "Aprovado 3DS",
	"subAcquirer": "Sub Acquirer Name",
	"list": {
		"typeID": 3,
		"id": "List Code Example"
	},
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@pemail.com.br",
		"login": "SocialNetworkLogin"
	},
	"socialNetwork": {
		"optInCompreConfie": 1,
		"typeSocialNetwork": 2,
		"authenticationToken": "123456abcd"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		]
	},
	"shipping": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		],
		"deliveryType": "1",
		"deliveryTime": "2 dias úteis",
		"price": 5.00,
		"pickUpStoreDocument": "12345678910"
	},
	"payments": [{
			"sequential": 1,
			"date": "2017-03-21T22:36:53.0000000",
			"value": 25.00,
			"type": 1,
			"installments": 1,
			"interestRate": 10,
			"interestValue": 2.00,
			"currency": 986,
			"voucherOrderOrigin": "123456",
			"card": {
				"number": "123456xxxxxx1234",
				"hash": "12345678945612301234569874563210",
				"bin": "123456",
				"end": "1234",
				"type": 1,
				"validityDate": "02/2021",
				"ownerName": "Owner Card Name",
				"document": "12345678910",
				"nsu": "12345"
			},
			"address": {
				"street": "Street name example",
				"number": "10",
				"additionalInformation": "Additional information example",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"zipcode": "12345678",
				"country": "Brasil",
				"reference": "Address reference example"
			}
		}
	],
	"items": [{
			"code": "Item Code",
			"name": "Item description",
			"barCode": "1234567891012",
			"value": 10.00,
			"amount": 1,
			"categoryID": 1,
			"categoryName": "Item category name",
			"isGift": true,
			"sellerName": "Seller Name",
			"sellerDocument": "12345678910123",
			"isMarketPlace": "true",
			"sellerSegment": "Eletronicos",
			"shippingCompany": "Shipping Company Name"
		}
	],
	"passengers": [{
			"name": "Passanger name",
			"companyMileCard": "Company Name",
			"mileCard": "123456789",
			"identificationType": 1,
			"identificationNumber": "123456789",
			"gender": "M",
			"birthdate": "1990-01-10T00:00:00.000",
			"cpf": "12345678910"
		}
	],
	"connections": [{
			"company": "JJ",
			"identificationNumber": 12345,
			"date": "2017-10-10T00:00:00.000",
			"seatClass": "Seat Class",
			"origin": "GRU",
			"destination": "LHR",
			"boarding": "2017-10-10T00:00:00.000",
			"arriving": "2017-10-10T00:00:00.000",
			"fareClass": "First Class"
		}
	],
	"hotels": [{
			"name": "Hotel Name",
			"city": "Hotel City",
			"state": "Hotel State",
			"country": "Hotel Country",
			"reservationDate": "2017-10-10T00:00:00.000",
			"reserveExpirationDate": "2017-10-10T00:00:00.000",
			"checkInDate": "2017-10-10T00:00:00.000",
			"checkOutDate": "2017-10-10T00:00:00.000"
		}
	]
}

Resposta

                Content-Type: application/json
Request-ID: 12J6-11B3-11A7-93C0
{
  "packageID": "4825dc1d-5246-45d3-ba32-d2de9bbff478",
  "orders": [
    {
      "code": "{CODIGO_DO_MEU_PEDIDO}",
      "status": "NVO",
      "score": null
    }
  ]
}
            

Token Authentication

All sent requests must be realize through a 2048 char token.

A token is generate through a user login and a password that are sent by ClearSale.

Please contact your sales consultant for more information.

During the authentication, the expiration date is sent. It is necessary that you consider in your development the management of the useful life of the token based on it expiration date.

To receive this data, it is necessary to reserve a space of 2048 characters. Only generate a new token after your current token has expired.

Request

POST https://api.clearsale.com.br/v1/authenticate HTTP/1.1
Content-Type: application/json

{
    "name": "{Your User}",
    "password": "{Your Password}"
}

POST https://homologacao.clearsale.com.br/api/v1/authenticate HTTP/1.1
Content-Type: application/json

{
    "name": "{Your User}",
    "password": "{Your Password}"
}

Response

            HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Token": "{Token value}",
  "ExpirationDate": "{Token expiration date}"
}     
        

Send Orders

Request

POST https://api.clearsale.com.br/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
	"code": "ORDER_EXAMPLE_2_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59.9894222",
	"email": "email@email.com.br",
	"b2bB2c": "B2C",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"numberOfInstallments": 1,
	"ip": "192.168.0.1",
	"isGift": false,
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"channelID": "Additional origin information",
	"reservationDate": "2017-03-21T22:36:36.0000000",
	"country": "Brasil",
	"nationality": "Brasileiro",
	"product": 1,
	"customSla": 60,
	"bankAuthentication": "Aprovado 3DS",
	"subAcquirer": "Sub Acquirer Name",
	"list": {
		"typeID": 3,
		"id": "List Code Example"
	},
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@pemail.com.br",
		"login": "SocialNetworkLogin"
	},
	"socialNetwork": {
		"optInCompreConfie": 1,
		"typeSocialNetwork": 2,
		"authenticationToken": "123456abcd"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		]
	},
	"shipping": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		],
		"deliveryType": "1",
		"deliveryTime": "2 dias úteis",
		"price": 5.00,
		"pickUpStoreDocument": "12345678910"
	},
	"payments": [{
			"sequential": 1,
			"date": "2017-03-21T22:36:53.0000000",
			"value": 25.00,
			"type": 1,
			"installments": 1,
			"interestRate": 10,
			"interestValue": 2.00,
			"currency": 986,
			"voucherOrderOrigin": "123456",
			"card": {
				"number": "123456xxxxxx1234",
				"hash": "12345678945612301234569874563210",
				"bin": "123456",
				"end": "1234",
				"type": 1,
				"validityDate": "02/2021",
				"ownerName": "Owner Card Name",
				"document": "12345678910",
				"nsu": "12345"
			},
			"address": {
				"street": "Street name example",
				"number": "10",
				"additionalInformation": "Additional information example",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"zipcode": "12345678",
				"country": "Brasil",
				"reference": "Address reference example"
			}
		}
	],
	"items": [{
			"code": "Item Code",
			"name": "Item description",
			"barCode": "1234567891012",
			"value": 10.00,
			"amount": 1,
			"categoryID": 1,
			"categoryName": "Item category name",
			"isGift": true,
			"sellerName": "Seller Name",
			"sellerDocument": "12345678910123",
			"isMarketPlace": "true",
			"sellerSegment": "Eletronicos",
			"shippingCompany": "Shipping Company Name"
		}
	],
	"passengers": [{
			"name": "Passanger name",
			"companyMileCard": "Company Name",
			"mileCard": "123456789",
			"identificationType": 1,
			"identificationNumber": "123456789",
			"gender": "M",
			"birthdate": "1990-01-10T00:00:00.000",
			"cpf": "12345678910"
		}
	],
	"connections": [{
			"company": "JJ",
			"identificationNumber": 12345,
			"date": "2017-10-10T00:00:00.000",
			"seatClass": "Seat Class",
			"origin": "GRU",
			"destination": "LHR",
			"boarding": "2017-10-10T00:00:00.000",
			"arriving": "2017-10-10T00:00:00.000",
			"fareClass": "First Class"
		}
	],
	"hotels": [{
			"name": "Hotel Name",
			"city": "Hotel City",
			"state": "Hotel State",
			"country": "Hotel Country",
			"reservationDate": "2017-10-10T00:00:00.000",
			"reserveExpirationDate": "2017-10-10T00:00:00.000",
			"checkInDate": "2017-10-10T00:00:00.000",
			"checkOutDate": "2017-10-10T00:00:00.000"
		}
	]
}

POST https://homologacao.clearsale.com.br/api/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
	"code": "ORDER_EXAMPLE_2_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59.9894222",
	"email": "email@email.com.br",
	"b2bB2c": "B2C",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"numberOfInstallments": 1,
	"ip": "192.168.0.1",
	"isGift": false,
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"channelID": "Additional origin information",
	"reservationDate": "2017-03-21T22:36:36.0000000",
	"country": "Brasil",
	"nationality": "Brasileiro",
	"product": 1,
	"customSla": 60,
	"bankAuthentication": "Aprovado 3DS",
	"list": {
		"typeID": 3,
		"id": "List Code Example"
	},
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@pemail.com.br",
		"login": "SocialNetworkLogin"
	},
	"socialNetwork": {
		"optInCompreConfie": 1,
		"typeSocialNetwork": 2,
		"authenticationToken": "123456abcd"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
			"type": 1,
			"ddi": 55,
			"ddd": 11,
			"number": 33333333,
			"extension": "1111"
		}]
	},
	"shipping": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
			"type": 1,
			"ddi": 55,
			"ddd": 11,
			"number": 33333333,
			"extension": "1111"
		}],
		"deliveryType": "1",
		"deliveryTime": "2 dias úteis",
		"price": 5.00,
		"pickUpStoreDocument": "12345678910"
	},
	"payments": [{
		"sequential": 1,
		"date": "2017-03-21T22:36:53.0000000",
		"value": 25.00,
		"type": 1,
		"installments": 1,
		"interestRate": 10,
		"interestValue": 2.00,
		"currency": 986,
		"voucherOrderOrigin": "123456",
		"card": {
			"number": "123456xxxxxx1234",
			"hash": "12345678945612301234569874563210",
			"bin": "123456",
			"end": "1234",
			"type": 1,
			"validityDate": "02/2021",
			"ownerName": "Owner Card Name",
			"document": "12345678910",
			"nsu": "12345"
		},
		"address": {
			"street": "Street name example",
			"number": "10",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		}
	}],
	"items": [{
		"code": "Item Code",
		"name": "Item description",
		"value": 10.00,
		"amount": 1,
		"categoryID": 1,
		"categoryName": "Item category name",
		"isGift": true,
		"sellerName": "Seller Name",
		"isMarketPlace": "true",
		"shippingCompany": "Shipping Company Name"
	}],
	"passengers": [{
		"name": "Passanger name",
		"companyMileCard": "Company Name",
		"mileCard": "123456789",
		"identificationType": 1,
		"identificationNumber": "123456789",
		"gender": "M",
		"birthdate": "1990-01-10T00:00:00.000",
		"cpf": "12345678910"
	}],
	"connections": [{
		"company": "JJ",
		"identificationNumber": 12345,
		"date": "2017-10-10T00:00:00.000",
		"seatClass": "Seat Class",
		"origin": "GRU",
		"destination": "LHR",
		"boarding": "2017-10-10T00:00:00.000",
		"arriving": "2017-10-10T00:00:00.000",
		"fareClass": "First Class"
	}],
	"hotels": [{
		"name": "Hotel Name",
		"city": "Hotel City",
		"state": "Hotel State",
		"country": "Hotel Country",
		"reservationDate": "2017-10-10T00:00:00.000",
		"reserveExpirationDate": "2017-10-10T00:00:00.000",
		"checkInDate": "2017-10-10T00:00:00.000",
		"checkOutDate": "2017-10-10T00:00:00.000"
	}]
}

Response

                Content-Type: application/json
Request-ID: 12J6-11B3-11A7-93C0
{
  "packageID": "4825dc1d-5246-45d3-ba32-d2de9bbff478",
  "orders": [
    {
      "code": "{ORDER_CODE}",
      "status": "NVO",
      "score": null
    }
  ]
}
            

Reanálise de Pedidos

Requisição

PUT https://api.clearsale.com.br/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
	"code": "ORDER_EXAMPLE_2_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59.9894222",
	"email": "email@email.com.br",
	"b2bB2c": "B2C",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"numberOfInstallments": 1,
	"ip": "192.168.0.1",
	"isGift": false,
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"channelID": "Additional origin information",
	"reservationDate": "2017-03-21T22:36:36.0000000",
	"country": "Brasil",
	"nationality": "Brasileiro",
	"product": 1,
	"customSla": 60,
	"bankAuthentication": "Aprovado 3DS",
	"subAcquirer": "Sub Acquirer Name",
	"list": {
		"typeID": 3,
		"id": "List Code Example"
	},
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@pemail.com.br",
		"login": "SocialNetworkLogin"
	},
	"socialNetwork": {
		"optInCompreConfie": 1,
		"typeSocialNetwork": 2,
		"authenticationToken": "123456abcd"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		]
	},
	"shipping": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		],
		"deliveryType": "1",
		"deliveryTime": "2 dias úteis",
		"price": 5.00,
		"pickUpStoreDocument": "12345678910"
	},
	"payments": [{
			"sequential": 1,
			"date": "2017-03-21T22:36:53.0000000",
			"value": 25.00,
			"type": 1,
			"installments": 1,
			"interestRate": 10,
			"interestValue": 2.00,
			"currency": 986,
			"voucherOrderOrigin": "123456",
			"card": {
				"number": "123456xxxxxx1234",
				"hash": "12345678945612301234569874563210",
				"bin": "123456",
				"end": "1234",
				"type": 1,
				"validityDate": "02/2021",
				"ownerName": "Owner Card Name",
				"document": "12345678910",
				"nsu": "12345"
			},
			"address": {
				"street": "Street name example",
				"number": "10",
				"additionalInformation": "Additional information example",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"zipcode": "12345678",
				"country": "Brasil",
				"reference": "Address reference example"
			}
		}
	],
	"items": [{
			"code": "Item Code",
			"name": "Item description",
			"barCode": "1234567891012",
			"value": 10.00,
			"amount": 1,
			"categoryID": 1,
			"categoryName": "Item category name",
			"isGift": true,
			"sellerName": "Seller Name",
			"sellerDocument": "12345678910123",
			"isMarketPlace": "true",
			"sellerSegment": "Eletronicos",
			"shippingCompany": "Shipping Company Name"
		}
	],
	"passengers": [{
			"name": "Passanger name",
			"companyMileCard": "Company Name",
			"mileCard": "123456789",
			"identificationType": 1,
			"identificationNumber": "123456789",
			"gender": "M",
			"birthdate": "1990-01-10T00:00:00.000",
			"cpf": "12345678910"
		}
	],
	"connections": [{
			"company": "JJ",
			"identificationNumber": 12345,
			"date": "2017-10-10T00:00:00.000",
			"seatClass": "Seat Class",
			"origin": "GRU",
			"destination": "LHR",
			"boarding": "2017-10-10T00:00:00.000",
			"arriving": "2017-10-10T00:00:00.000",
			"fareClass": "First Class"
		}
	],
	"hotels": [{
			"name": "Hotel Name",
			"city": "Hotel City",
			"state": "Hotel State",
			"country": "Hotel Country",
			"reservationDate": "2017-10-10T00:00:00.000",
			"reserveExpirationDate": "2017-10-10T00:00:00.000",
			"checkInDate": "2017-10-10T00:00:00.000",
			"checkOutDate": "2017-10-10T00:00:00.000"
		}
	]
}

PUT https://homologacao.clearsale.com.br/api/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
	"code": "ORDER_EXAMPLE_2_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59.9894222",
	"email": "email@email.com.br",
	"b2bB2c": "B2C",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"numberOfInstallments": 1,
	"ip": "192.168.0.1",
	"isGift": false,
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"channelID": "Additional origin information",
	"reservationDate": "2017-03-21T22:36:36.0000000",
	"country": "Brasil",
	"nationality": "Brasileiro",
	"product": 1,
	"customSla": 60,
	"bankAuthentication": "Aprovado 3DS",
	"subAcquirer": "Sub Acquirer Name",
	"list": {
		"typeID": 3,
		"id": "List Code Example"
	},
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@pemail.com.br",
		"login": "SocialNetworkLogin"
	},
	"socialNetwork": {
		"optInCompreConfie": 1,
		"typeSocialNetwork": 2,
		"authenticationToken": "123456abcd"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		]
	},
	"shipping": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		],
		"deliveryType": "1",
		"deliveryTime": "2 dias úteis",
		"price": 5.00,
		"pickUpStoreDocument": "12345678910"
	},
	"payments": [{
			"sequential": 1,
			"date": "2017-03-21T22:36:53.0000000",
			"value": 25.00,
			"type": 1,
			"installments": 1,
			"interestRate": 10,
			"interestValue": 2.00,
			"currency": 986,
			"voucherOrderOrigin": "123456",
			"card": {
				"number": "123456xxxxxx1234",
				"hash": "12345678945612301234569874563210",
				"bin": "123456",
				"end": "1234",
				"type": 1,
				"validityDate": "02/2021",
				"ownerName": "Owner Card Name",
				"document": "12345678910",
				"nsu": "12345"
			},
			"address": {
				"street": "Street name example",
				"number": "10",
				"additionalInformation": "Additional information example",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"zipcode": "12345678",
				"country": "Brasil",
				"reference": "Address reference example"
			}
		}
	],
	"items": [{
			"code": "Item Code",
			"name": "Item description",
			"barCode": "1234567891012",
			"value": 10.00,
			"amount": 1,
			"categoryID": 1,
			"categoryName": "Item category name",
			"isGift": true,
			"sellerName": "Seller Name",
			"sellerDocument": "12345678910123",
			"isMarketPlace": "true",
			"sellerSegment": "Eletronicos",
			"shippingCompany": "Shipping Company Name"
		}
	],
	"passengers": [{
			"name": "Passanger name",
			"companyMileCard": "Company Name",
			"mileCard": "123456789",
			"identificationType": 1,
			"identificationNumber": "123456789",
			"gender": "M",
			"birthdate": "1990-01-10T00:00:00.000",
			"cpf": "12345678910"
		}
	],
	"connections": [{
			"company": "JJ",
			"identificationNumber": 12345,
			"date": "2017-10-10T00:00:00.000",
			"seatClass": "Seat Class",
			"origin": "GRU",
			"destination": "LHR",
			"boarding": "2017-10-10T00:00:00.000",
			"arriving": "2017-10-10T00:00:00.000",
			"fareClass": "First Class"
		}
	],
	"hotels": [{
			"name": "Hotel Name",
			"city": "Hotel City",
			"state": "Hotel State",
			"country": "Hotel Country",
			"reservationDate": "2017-10-10T00:00:00.000",
			"reserveExpirationDate": "2017-10-10T00:00:00.000",
			"checkInDate": "2017-10-10T00:00:00.000",
			"checkOutDate": "2017-10-10T00:00:00.000"
		}
	]
}

Resposta

        Content-Type: application/json
Request-ID: 12J6-11B3-11A7-93C0
{
  "packageID": "4825dc1d-5246-45d3-ba32-d2de9bbff478",
  "orders": [
    {
      "code": "{CODIGO_DO_MEU_PEDIDO}",
      "status": "NVO",
      "score": null
    }
  ]
}
    

Re-analysis of orders

Request

PUT https://api.clearsale.com.br/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
	"code": "ORDER_EXAMPLE_2_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59.9894222",
	"email": "email@email.com.br",
	"b2bB2c": "B2C",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"numberOfInstallments": 1,
	"ip": "192.168.0.1",
	"isGift": false,
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"channelID": "Additional origin information",
	"reservationDate": "2017-03-21T22:36:36.0000000",
	"country": "Brasil",
	"nationality": "Brasileiro",
	"product": 1,
	"customSla": 60,
	"bankAuthentication": "Aprovado 3DS",
	"subAcquirer": "Sub Acquirer Name",
	"list": {
		"typeID": 3,
		"id": "List Code Example"
	},
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@pemail.com.br",
		"login": "SocialNetworkLogin"
	},
	"socialNetwork": {
		"optInCompreConfie": 1,
		"typeSocialNetwork": 2,
		"authenticationToken": "123456abcd"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		]
	},
	"shipping": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		],
		"deliveryType": "1",
		"deliveryTime": "2 dias úteis",
		"price": 5.00,
		"pickUpStoreDocument": "12345678910"
	},
	"payments": [{
			"sequential": 1,
			"date": "2017-03-21T22:36:53.0000000",
			"value": 25.00,
			"type": 1,
			"installments": 1,
			"interestRate": 10,
			"interestValue": 2.00,
			"currency": 986,
			"voucherOrderOrigin": "123456",
			"card": {
				"number": "123456xxxxxx1234",
				"hash": "12345678945612301234569874563210",
				"bin": "123456",
				"end": "1234",
				"type": 1,
				"validityDate": "02/2021",
				"ownerName": "Owner Card Name",
				"document": "12345678910",
				"nsu": "12345"
			},
			"address": {
				"street": "Street name example",
				"number": "10",
				"additionalInformation": "Additional information example",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"zipcode": "12345678",
				"country": "Brasil",
				"reference": "Address reference example"
			}
		}
	],
	"items": [{
			"code": "Item Code",
			"name": "Item description",
			"barCode": "1234567891012",
			"value": 10.00,
			"amount": 1,
			"categoryID": 1,
			"categoryName": "Item category name",
			"isGift": true,
			"sellerName": "Seller Name",
			"sellerDocument": "12345678910123",
			"isMarketPlace": "true",
			"shippingCompany": "Shipping Company Name"
		}
	],
	"passengers": [{
			"name": "Passanger name",
			"companyMileCard": "Company Name",
			"mileCard": "123456789",
			"identificationType": 1,
			"identificationNumber": "123456789",
			"gender": "M",
			"birthdate": "1990-01-10T00:00:00.000",
			"cpf": "12345678910"
		}
	],
	"connections": [{
			"company": "JJ",
			"identificationNumber": 12345,
			"date": "2017-10-10T00:00:00.000",
			"seatClass": "Seat Class",
			"origin": "GRU",
			"destination": "LHR",
			"boarding": "2017-10-10T00:00:00.000",
			"arriving": "2017-10-10T00:00:00.000",
			"fareClass": "First Class"
		}
	],
	"hotels": [{
			"name": "Hotel Name",
			"city": "Hotel City",
			"state": "Hotel State",
			"country": "Hotel Country",
			"reservationDate": "2017-10-10T00:00:00.000",
			"reserveExpirationDate": "2017-10-10T00:00:00.000",
			"checkInDate": "2017-10-10T00:00:00.000",
			"checkOutDate": "2017-10-10T00:00:00.000"
		}
	]
}

PUT https://homologacao.clearsale.com.br/api/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
	"code": "ORDER_EXAMPLE_2_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59.9894222",
	"email": "email@email.com.br",
	"b2bB2c": "B2C",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"numberOfInstallments": 1,
	"ip": "192.168.0.1",
	"isGift": false,
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"channelID": "Additional origin information",
	"reservationDate": "2017-03-21T22:36:36.0000000",
	"country": "Brasil",
	"nationality": "Brasileiro",
	"product": 1,
	"customSla": 60,
	"bankAuthentication": "Aprovado 3DS",
	"subAcquirer": "Sub Acquirer Name",
	"list": {
		"typeID": 3,
		"id": "List Code Example"
	},
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@pemail.com.br",
		"login": "SocialNetworkLogin"
	},
	"socialNetwork": {
		"optInCompreConfie": 1,
		"typeSocialNetwork": 2,
		"authenticationToken": "123456abcd"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		]
	},
	"shipping": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
				"type": 1,
				"ddi": 55,
				"ddd": 11,
				"number": 33333333,
				"extension": "1111"
			}
		],
		"deliveryType": "1",
		"deliveryTime": "2 dias úteis",
		"price": 5.00,
		"pickUpStoreDocument": "12345678910"
	},
	"payments": [{
			"sequential": 1,
			"date": "2017-03-21T22:36:53.0000000",
			"value": 25.00,
			"type": 1,
			"installments": 1,
			"interestRate": 10,
			"interestValue": 2.00,
			"currency": 986,
			"voucherOrderOrigin": "123456",
			"card": {
				"number": "123456xxxxxx1234",
				"hash": "12345678945612301234569874563210",
				"bin": "123456",
				"end": "1234",
				"type": 1,
				"validityDate": "02/2021",
				"ownerName": "Owner Card Name",
				"document": "12345678910",
				"nsu": "12345"
			},
			"address": {
				"street": "Street name example",
				"number": "10",
				"additionalInformation": "Additional information example",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"zipcode": "12345678",
				"country": "Brasil",
				"reference": "Address reference example"
			}
		}
	],
	"items": [{
			"code": "Item Code",
			"name": "Item description",
			"barCode": "1234567891012",
			"value": 10.00,
			"amount": 1,
			"categoryID": 1,
			"categoryName": "Item category name",
			"isGift": true,
			"sellerName": "Seller Name",
			"sellerDocument": "12345678910123",
			"isMarketPlace": "true",
			"shippingCompany": "Shipping Company Name"
		}
	],
	"passengers": [{
			"name": "Passanger name",
			"companyMileCard": "Company Name",
			"mileCard": "123456789",
			"identificationType": 1,
			"identificationNumber": "123456789",
			"gender": "M",
			"birthdate": "1990-01-10T00:00:00.000",
			"cpf": "12345678910"
		}
	],
	"connections": [{
			"company": "JJ",
			"identificationNumber": 12345,
			"date": "2017-10-10T00:00:00.000",
			"seatClass": "Seat Class",
			"origin": "GRU",
			"destination": "LHR",
			"boarding": "2017-10-10T00:00:00.000",
			"arriving": "2017-10-10T00:00:00.000",
			"fareClass": "First Class"
		}
	],
	"hotels": [{
			"name": "Hotel Name",
			"city": "Hotel City",
			"state": "Hotel State",
			"country": "Hotel Country",
			"reservationDate": "2017-10-10T00:00:00.000",
			"reserveExpirationDate": "2017-10-10T00:00:00.000",
			"checkInDate": "2017-10-10T00:00:00.000",
			"checkOutDate": "2017-10-10T00:00:00.000"
		}
	]
}

Response

        Content-Type: application/json
Request-ID: 12J6-11B3-11A7-93C0
{
  "packageID": "4825dc1d-5246-45d3-ba32-d2de9bbff478",
  "orders": [
    {
      "code": "{ORDER_CODE}",
      "status": "NVO",
      "score": null
    }
  ]
}
    

Código	Descrição
0	Não definido
1	Residencial
2	Comercial
3	Recados
4	Cobrança
5	Temporário
6	Celular

ID	Description
0	Undefined
1	Home
2	Work
3	Messages
4	Billing Phone
5	Temporary
6	Mobile

Código	Descrição
1	CPF
2	CNPJ
3	RG
4	IE
5	Passaporte
6	CTPS
7	Título Eleitor

ID	Description
1	CPF
2	CNPJ
3	RG
4	IE
5	Passport
6	CTPS
7	Voter ID Card

Código	Descrição
1	Pessoa Física
2	Pessoa Jurídica

ID	Description
1	Natural Person
2	Legal Person

Código	Descrição
M	Masculino
F	Feminino

ID	Description
M	Male
F	Female

Código	Descrição
1	Cartão de Crédito
2	Boleto Bancário
3	Débito Bancário
4	Débito Bancário - Dinheiro
5	Débito Bancário - Cheque
6	Transferência Bancária
7	Sedex a cobrar
8	Cheque
9	Dinheiro
10	Financiamento
11	Fatura
12	Cupom
13	Multicheque
14	Outros
16	Vale
19	Cartão de Débito
23	Vale Alimentação
27	PIX
28	Cashback
1041	Cartão Presente Virtual
4011	Cartão de Débito / Transferência Eletrônica (CD)

ID	Description
1	Credit Card
2	Bank Slip
3	Bank Debit
4	Bank Debit - Money
5	Bank Debit - Check
6	Bank Transfer
7	Sedex
8	Check
9	Money
10	Financing
11	Invoice
12	Coupon
13	Multicheque
14	Other
16	Voucher
19	Debit Card
23	Food voucher
27	PIX
28	Cashback
1041	Virtual gift card
4011	Debit Card / Eletronic transfer

Código	Descrição
1	Diners
2	MasterCard
3	Visa
4	Outros
5	American Express
6	HiperCard
7	Aura
10	Cartão Elo
50	LeaderCard
100	Fortbrasil
101	Sorocred
102	A Vista
103	Cartão Mais
105	Cartão C&A

ID	Description
1	Diners
2	MasterCard
3	Visa
4	Other
5	American Express
6	HiperCard
7	Aura
10	Elo Card
50	LeaderCard
100	Fortbrasil
101	Sorocred
102	Debit Card
103	Mais Card
105	C&A Card

Lista de Status (de retorno)

Status	Descrição
APA	(Aprovação Automática) – Pedido foi aprovado automaticamente segundo parâmetros definidos na regra de aprovação automática
APM	(Aprovação Manual) – Pedido aprovado manualmente por tomada de decisão de um analista
RPM	(Reprovado Sem Suspeita) – Pedido Reprovado sem Suspeita por falta de contato com o cliente dentro do período acordado e/ou políticas restritivas de CPF (Irregular, SUS ou Cancelados)
AMA	(Análise manual) – Pedido está em fila para análise
NVO	(Novo) – Pedido importado e não classificado Score pela analisadora (processo que roda o Score de cada pedido)
SUS	(Suspensão Manual) – Pedido Suspenso por suspeita de fraude baseado no contato com o “cliente” ou ainda na base ClearSale
CAN	(Cancelado pelo Cliente) – Cancelado por solicitação do cliente ou duplicidade do pedido
FRD	(Fraude Confirmada) – Pedido imputado como Fraude Confirmada por contato com a administradora de cartão e/ou contato com titular do cartão ou CPF do cadastro que desconhecem a compra
RPA	(Reprovação Automática) – Pedido Reprovado Automaticamente por algum tipo de Regra de Negócio que necessite aplicá-la
RPP	(Reprovação Por Política) – Pedido reprovado automaticamente por política estabelecida pelo cliente ou Clearsale
APP	(Aprovação Por Política) – Pedido aprovado automaticamente por política estabelecida pelo cliente ou Clearsale

ID	Description
APA	Automatic Approval - Order automatically approved based on predefined rule
APM	Manual Approval - Order manually approved by an analyst’s decision-making
RPM	Denied Without Suspicion - Order denied for lack of successful contact or restrictive policies
AMA	Manual Analysis - Order waiting for manual analysis
NVO	New - Order successfully received, but not classified yet
SUS	Manual Suspension - Order suspended manually for fraud suspicion
CAN	Cancelled by Customer - Cancelled by customer solicitation
FRD	Confirmed Fraud - Order analyzed and based on the contact, the credit card company stated the fraud or the actual owner of the card is not aware of the purchase
RPA	Denied Automatically - Order automatically denied based on predefined rule (Not recommended)
RPP	Denied by Policies – Order denied due to policies defined by ClearSale or customer
APP	Approved by Policies – Order approved due to policies defined by ClearSale or customer

Código	Descrição
0	Novo (será analisado pelo ClearSale)
9	Aprovado (irá ao ClearSale já aprovado e não será analisado)
41	Cancelado pelo cliente (irá ao ClearSale já cancelado e não será analisado)
45	Reprovado (irá ao ClearSale já reprovado e não será analisado)

ID	Description
0	New
9	Approved - This order will not be analyzed by Clearsale
41	Cancelled by the customer - This order will not be analyzed by Clearsale
45	Denied - The order will not be analyzed by Clearsale

Código	Descrição
PGA	Pagamento Aprovado
PGR	Pagamento Reprovado

ID	Description
PGA	Payment Approved
PGR	Payment Denied

Código	Descrição
0	Outros
1	Normal
2	Garantida
3	ExpressaBR
4	ExpressaSP
5	Alta
6	Econômica
7	Agendada
8	Extra Rápida
9	Impresso
10	Aplicativo
11	Correio
12	Motoboy
13	Retirada Bilheteria
14	Retirada Loja Parceira
15	Cartão de Crédito Ingresso
16	Retirada Loja
17	Retirada via Lockers (Parceiros)
18	Retirada em Agencia dos Correios
19	Entrega Garantida no mesmo dia da compra
20	Entrega Garantida no dia seguinte da compra
21	Retirada em loja - Expresso

ID	Description
0	Others
1	Normal
2	Guaranteed
3	Express Brazil
4	Express São Paulo
5	High
6	Economic
7	Schedueld
8	Extra Fast
9	Via Print
10	Via App
11	Mail
12	Motocycle Courier
13	Withdrawl at Ticket box
14	Withdrawal at Partner Store
15	Ticket Credit Card
16	Withdrawl at Store
17	Withdrawl via Lockers (Partners)
18	Withdrawl at Mail Agency
19	Guaranteed delivery on the same day of purchase
20	Guaranteed delivery the day after the purchase
21	Withdrawl at Store - Express

ID	Descrição
1	Lista Não Cadastrada
2	Lista de Chá de Bebê
3	Lista de Casamento
4	Lista de Desejos
5	Lista de Aniversário
6	Chá Bar / Chá de Panela

ID	Description
1	Undefined
2	Baby Shower
3	Wedding List
4	Wish List
5	Bithday List
6	Bridal Shower

ID	Descrição
1	Facebook
2	Twitter
3	Linkedin
4	Google
5	Outros

ID	Description
1	Facebook
2	Twitter
3	Linkedin
4	Google
5	Others

ID	Descrição
-1	Outros
1	Application
3	Total
4	Total Garantido
9	Score
10	Realtime Decision
11	Tickets

ID	Description
-1	Other
1	Application
3	Total
4	Total Garantido
9	Score
10	Realtime Decision
11	Tickets

Lista de moeda (payment.currency)

Moeda	Código Alfabético	Código Numérico
ADB Unit of Account	XUA	965
Afghani	AFN	971
Algerian Dinar	DZD	12
Argentine Peso	ARS	32
Armenian Dram	AMD	51
Aruban Florin	AWG	533
Australian Dollar	AUD	36
Azerbaijanian Manat	AZN	944
Bahamian Dollar	BSD	44
Bahraini Dinar	BHD	48
Baht	THB	764
Balboa	PAB	590
Barbados Dollar	BBD	52
Belarussian Ruble	BYR	974
Belize Dollar	BZD	84
Bermudian Dollar	BMD	60
Bolivar Fuerte	VEF	937
Boliviano	BOB	68
Bond Markets Unit European Composite Unit (EURCO)	XBA	955
Bond Markets Unit European Monetary Unit (E.M.U.-6)	XBB	956
Bond Markets Unit European Unit of Account 17 (E.U.A.-17)	XBD	958
Bond Markets Unit European Unit of Account 9 (E.U.A.-9)	XBC	957
Brazilian Real	BRL	986
Brunei Dollar	BND	96
Bulgarian Lev	BGN	975
Burundi Franc	BIF	108
Canadian Dollar	CAD	124
Cape Verde Escudo	CVE	132
Cayman Islands Dollar	KYD	136
CFA Franc BCEAO	XOF	952
CFA Franc BEAC	XAF	950
CFP Franc	XPF	953
Chilean Peso	CLP	152
Codes specifically reserved for testing purposes	XTS	963
Colombian Peso	COP	170
Comoro Franc	KMF	174
Congolese Franc	CDF	976
Convertible Mark	BAM	977
Cordoba Oro	NIO	558
Costa Rican Colon	CRC	188
Croatian Kuna	HRK	191
Cuban Peso	CUP	192
Czech Koruna	CZK	203
Dalasi	GMD	270
Danish Krone	DKK	208
Denar	MKD	807
Djibouti Franc	DJF	262
Dobra	STD	678
Dominican Peso	DOP	214
Dong	VND	704
East Caribbean Dollar	XCD	951
Egyptian Pound	EGP	818
El Salvador Colon	SVC	222
Ethiopian Birr	ETB	230
Euro	EUR	978
Falkland Islands Pound	FKP	238
Fiji Dollar	FJD	242
Forint	HUF	348
Ghana Cedi	GHS	936
Gibraltar Pound	GIP	292
Gold	XAU	959
Gourde	HTG	332
Guarani	PYG	600
Guinea Franc	GNF	324
Guyana Dollar	GYD	328
Hong Kong Dollar	HKD	344
Hryvnia	UAH	980
Iceland Krona	ISK	352
Indian Rupee	INR	356
Iranian Rial	IRR	364
Iraqi Dinar	IQD	368
Jamaican Dollar	JMD	388
Jordanian Dinar	JOD	400
Kenyan Shilling	KES	404
Kina	PGK	598
Kip	LAK	418
Kuwaiti Dinar	KWD	414
Kwacha	MWK	454
Kwanza	AOA	973
Kyat	MMK	104
Lari	GEL	981
Latvian Lats	LVL	428
Lebanese Pound	LBP	422
Lek	ALL	8
Lempira	HNL	340
Leone	SLL	694
Liberian Dollar	LRD	430
Libyan Dinar	LYD	434
Lilangeni	SZL	748
Lithuanian Litas	LTL	440
Loti	LSL	426
Malagasy Ariary	MGA	969
Malaysian Ringgit	MYR	458
Mauritius Rupee	MUR	480
Mexican Peso	MXN	484
Mexican Unidad de Inversion (UDI)	MXV	979
Moldovan Leu	MDL	498
Moroccan Dirham	MAD	504
Mozambique Metical	MZN	943
Mvdol	BOV	984
Naira	NGN	566
Nakfa	ERN	232
Namibia Dollar	NAD	516
Nepalese Rupee	NPR	524
Netherlands Antillean Guilder	ANG	532
New Israeli Sheqel	ILS	376
New Romanian Leu	RON	946
New Taiwan Dollar	TWD	901
New Zealand Dollar	NZD	554
Ngultrum	BTN	64
North Korean Won	KPW	408
Norwegian Krone	NOK	578
Nuevo Sol	PEN	604
Ouguiya	MRO	478
Pa'anga	TOP	776
Pakistan Rupee	PKR	586
Palladium	XPD	964
Pataca	MOP	446
Peso Convertible	CUC	931
Peso Uruguayo	UYU	858
Philippine Peso	PHP	608
Platinum	XPT	962
Pound Sterling	GBP	826
Pula	BWP	72
Qatari Rial	QAR	634
Quetzal	GTQ	320
Rand	ZAR	710
Rial Omani	OMR	512
Riel	KHR	116
Rufiyaa	MVR	462
Rupiah	IDR	360
Russian Ruble	RUB	643
Rwanda Franc	RWF	646
Saint Helena Pound	SHP	654
Saudi Riyal	SAR	682
SDR (Special Drawing Right)	XDR	960
Serbian Dinar	RSD	941
Seychelles Rupee	SCR	690
Silver	XAG	961
Singapore Dollar	SGD	702
Solomon Islands Dollar	SBD	90
Som	KGS	417
Somali Shilling	SOS	706
Somoni	TJS	972
South Sudanese Pound	SSP	728
Sri Lanka Rupee	LKR	144
Sucre	XSU	994
Sudanese Pound	SDG	938
Surinam Dollar	SRD	968
Swedish Krona	SEK	752
Swiss Franc	CHF	756
Syrian Pound	SYP	760
Taka	BDT	50
Tala	WST	882
Tanzanian Shilling	TZS	834
Tenge	KZT	398
Trinidad and Tobago Dollar	TTD	780
Tugrik	MNT	496
Tunisian Dinar	TND	788
Turkish Lira	TRY	949
Turkmenistan New Manat	TMT	934
UAE Dirham	AED	784
Uganda Shilling	UGX	800
UIC-Franc	XFU	Nil
Unidad de Valor Real	COU	970
Unidades de fomento	CLF	990
Uruguay Peso en Unidades Indexadas (URUIURUI)	UYI	940
US Dollar	USD	840
US Dollar (Next day)	USN	997
US Dollar (Same day)	USS	998
Uzbekistan Sum	UZS	860
Vatu	VUV	548
WIR Euro	CHE	947
WIR Franc	CHW	948
Won	KRW	410
Yemeni Rial	YER	886
Yen	JPY	392
Yuan Renminbi	CNY	156
Zambian Kwacha	ZMK	894
Zimbabwe Dollar	ZWL	932
Zloty	PLN	985

Currency list (payment.currency)

Currency	Alphabetic Code	Numeric Code
ADB Unit of Account	XUA	965
Afghani	AFN	971
Algerian Dinar	DZD	12
Argentine Peso	ARS	32
Armenian Dram	AMD	51
Aruban Florin	AWG	533
Australian Dollar	AUD	36
Azerbaijanian Manat	AZN	944
Bahamian Dollar	BSD	44
Bahraini Dinar	BHD	48
Baht	THB	764
Balboa	PAB	590
Barbados Dollar	BBD	52
Belarussian Ruble	BYR	974
Belize Dollar	BZD	84
Bermudian Dollar	BMD	60
Bolivar Fuerte	VEF	937
Boliviano	BOB	68
Bond Markets Unit European Composite Unit (EURCO)	XBA	955
Bond Markets Unit European Monetary Unit (E.M.U.-6)	XBB	956
Bond Markets Unit European Unit of Account 17 (E.U.A.-17)	XBD	958
Bond Markets Unit European Unit of Account 9 (E.U.A.-9)	XBC	957
Brazilian Real	BRL	986
Brunei Dollar	BND	96
Bulgarian Lev	BGN	975
Burundi Franc	BIF	108
Canadian Dollar	CAD	124
Cape Verde Escudo	CVE	132
Cayman Islands Dollar	KYD	136
CFA Franc BCEAO	XOF	952
CFA Franc BEAC	XAF	950
CFP Franc	XPF	953
Chilean Peso	CLP	152
Codes specifically reserved for testing purposes	XTS	963
Colombian Peso	COP	170
Comoro Franc	KMF	174
Congolese Franc	CDF	976
Convertible Mark	BAM	977
Cordoba Oro	NIO	558
Costa Rican Colon	CRC	188
Croatian Kuna	HRK	191
Cuban Peso	CUP	192
Czech Koruna	CZK	203
Dalasi	GMD	270
Danish Krone	DKK	208
Denar	MKD	807
Djibouti Franc	DJF	262
Dobra	STD	678
Dominican Peso	DOP	214
Dong	VND	704
East Caribbean Dollar	XCD	951
Egyptian Pound	EGP	818
El Salvador Colon	SVC	222
Ethiopian Birr	ETB	230
Euro	EUR	978
Falkland Islands Pound	FKP	238
Fiji Dollar	FJD	242
Forint	HUF	348
Ghana Cedi	GHS	936
Gibraltar Pound	GIP	292
Gold	XAU	959
Gourde	HTG	332
Guarani	PYG	600
Guinea Franc	GNF	324
Guyana Dollar	GYD	328
Hong Kong Dollar	HKD	344
Hryvnia	UAH	980
Iceland Krona	ISK	352
Indian Rupee	INR	356
Iranian Rial	IRR	364
Iraqi Dinar	IQD	368
Jamaican Dollar	JMD	388
Jordanian Dinar	JOD	400
Kenyan Shilling	KES	404
Kina	PGK	598
Kip	LAK	418
Kuwaiti Dinar	KWD	414
Kwacha	MWK	454
Kwanza	AOA	973
Kyat	MMK	104
Lari	GEL	981
Latvian Lats	LVL	428
Lebanese Pound	LBP	422
Lek	ALL	8
Lempira	HNL	340
Leone	SLL	694
Liberian Dollar	LRD	430
Libyan Dinar	LYD	434
Lilangeni	SZL	748
Lithuanian Litas	LTL	440
Loti	LSL	426
Malagasy Ariary	MGA	969
Malaysian Ringgit	MYR	458
Mauritius Rupee	MUR	480
Mexican Peso	MXN	484
Mexican Unidad de Inversion (UDI)	MXV	979
Moldovan Leu	MDL	498
Moroccan Dirham	MAD	504
Mozambique Metical	MZN	943
Mvdol	BOV	984
Naira	NGN	566
Nakfa	ERN	232
Namibia Dollar	NAD	516
Nepalese Rupee	NPR	524
Netherlands Antillean Guilder	ANG	532
New Israeli Sheqel	ILS	376
New Romanian Leu	RON	946
New Taiwan Dollar	TWD	901
New Zealand Dollar	NZD	554
Ngultrum	BTN	64
North Korean Won	KPW	408
Norwegian Krone	NOK	578
Nuevo Sol	PEN	604
Ouguiya	MRO	478
Pa'anga	TOP	776
Pakistan Rupee	PKR	586
Palladium	XPD	964
Pataca	MOP	446
Peso Convertible	CUC	931
Peso Uruguayo	UYU	858
Philippine Peso	PHP	608
Platinum	XPT	962
Pound Sterling	GBP	826
Pula	BWP	72
Qatari Rial	QAR	634
Quetzal	GTQ	320
Rand	ZAR	710
Rial Omani	OMR	512
Riel	KHR	116
Rufiyaa	MVR	462
Rupiah	IDR	360
Russian Ruble	RUB	643
Rwanda Franc	RWF	646
Saint Helena Pound	SHP	654
Saudi Riyal	SAR	682
SDR (Special Drawing Right)	XDR	960
Serbian Dinar	RSD	941
Seychelles Rupee	SCR	690
Silver	XAG	961
Singapore Dollar	SGD	702
Solomon Islands Dollar	SBD	90
Som	KGS	417
Somali Shilling	SOS	706
Somoni	TJS	972
South Sudanese Pound	SSP	728
Sri Lanka Rupee	LKR	144
Sucre	XSU	994
Sudanese Pound	SDG	938
Surinam Dollar	SRD	968
Swedish Krona	SEK	752
Swiss Franc	CHF	756
Syrian Pound	SYP	760
Taka	BDT	50
Tala	WST	882
Tanzanian Shilling	TZS	834
Tenge	KZT	398
Trinidad and Tobago Dollar	TTD	780
Tugrik	MNT	496
Tunisian Dinar	TND	788
Turkish Lira	TRY	949
Turkmenistan New Manat	TMT	934
UAE Dirham	AED	784
Uganda Shilling	UGX	800
UIC-Franc	XFU	Nil
Unidad de Valor Real	COU	970
Unidades de fomento	CLF	990
Uruguay Peso en Unidades Indexadas (URUIURUI)	UYI	940
US Dollar	USD	840
US Dollar (Next day)	USN	997
US Dollar (Same day)	USS	998
Uzbekistan Sum	UZS	860
Vatu	VUV	548
WIR Euro	CHE	947
WIR Franc	CHW	948
Won	KRW	410
Yemeni Rial	YER	886
Yen	JPY	392
Yuan Renminbi	CNY	156
Zambian Kwacha	ZMK	894
Zimbabwe Dollar	ZWL	932
Zloty	PLN	985

Objeto order

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
code	Código do pedido	String	50	S
sessionID	Identificador único da sessão do usuário	String	128	S
date	Data do pedido	Datetime		S
email	Email do pedido	String	150	S
b2bB2c	Tipo do ecommerce	String	3	N
itemValue	Valor Total dos Itens	Decimal	20,4	N
totalValue	Valor Total do Pedido. Composto pelo Valor Total dos Itens + Valor do Frete + Eventual Valor de Juros da Compra	Decimal	20,4	S
numberOfInstallments	Quantidade de Parcelas	Integer		N
ip	IP do Pedido	String	50	S
isGift	Identifica se o pedido é presente	Boolean		N
giftMessage	Mensagem de Presente	String	8000	N
observation	Observação do Pedido	String	8000	N
status	Status do Pedido	Integer		N
origin	Canal de Origem do Pedido (ex: TELEVENDAS, WEBSITE, APP, etc.)	String	150	S
channelID	Canal de Origem complementar, se houver. (ex: ANDROID, IOS, etc.)	String	150	N
reservationDate	Data do Primeiro Voo do Pedido (em caso de aéreas)	Datetime		N
country	Nome do País	String	50	N
nationality	Nome da Nacionalidade	String	50	N
product	ID do produto	Integer		N
customSla	Valor em Minutos de SLA máximo de Análise do Pedido, se houver	Integer		S (Se aplicável)
bankAuthentication	Tipo de autenticação do banco	String	100	N
subAcquirer	Nome do sub adquirente	String	200	N
list	tipo de lista	list		N
purchaseInformation	Dados de cobrança	purchaseInformation		N
socialNetwork	socialNetwork	socialNetwork		N
billing	Dados de cobrança	billing		S
shipping	Dados de entrega	shipping		S
payments	Dados de pagamento	Array<payment>		S
items	items	Array<item>		S
passengers	passengers	Array<passenger>		N
connections	connections	Array<connection>		N
hotels	hotels	Array<hotel>		N

Importante: O envio do campo “customSLA” está condicionado a necessidade da loja de obter o resultado da análise de determinados pedidos em um tempo menor que o SLA padrão acordado com a equipe Comercial em contrato.

O tempo de SLA diferenciado também deve ser acordado com o Comercial, e será respeitado apenas após prévia configuração interna e homologação do envio do dado.

Object Order

Property	Description	Type	Size	Mandatory
code	Order identification	String	50	Y
sessionID	The user session id of the website	String	128	Y
date	Order date	Datetime		Y
email	Order email	String	150	Y
b2bB2c	Ecommerce type	String	3	N
itemValue	Total value of the order	Decimal	20,4	N
totalValue	Total value of the order.	Decimal	20,4	Y
numberOfInstallments	Quantity of installments	Integer		N
ip	IP of the user who did the order	String	50	Y
isGift	Identifies if the order is a gift	Boolean		N
giftMessage	Message of the gift	String	8000	N
observation	Order note	String	8000	N
status	Initial order status See the list at Initial Status List	Integer		N
origin	Order origin	String	150	Y
channelID	Additional order origin info	String	150	N
reservationDate	Flight reservation date	Datetime		N
country	Country	String	50	N
nationality	Nationality name	String	50	N
product	Product ID	Integer		N
customSla	Deadline for customized analysis	Integer		Y (If applicable)
bankAuthentication	Bank authentication type	String	100	N
subAcquirer	Name of sub acquirer	String	200	N
list	List type	list		N
purchaseInformation	Object purchaseInformation	purchaseInformation		N
socialNetwork	Object socialNetwork	socialNetwork		N
billing	Object billing	billing		Y
shipping	Object shipping	shipping		Y
payments	Object payments	Array<payment>		Y
items	Object items	Array<item>		Y
passengers	Object passengers	Array<passenger>		N
connections	Object connections	Array<connection>		N
hotels	Object hotels	Array<hotel>		N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
typeID	ID do tipo de lista	Integer		S
id	ID da lista na loja	String	200	S

Property	Description	Type	Size	Mandatory
typeID	ID of the list type See the list at List Type List	Integer		Y
id	ID of the list on the store	String	200	Y

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
lastDateInsertedMail	Data da última alteração do e-mail	Datetime		N
lastDateChangePassword	Data da última alteração da senha	Datetime		N
lastDateChangePhone	Data da última alteração do telefone	Datetime		N
lastDateChangeMobilePhone	Data da última alteração do telefone móvel	Datetime		N
lastDateInsertedAddress	Data da última alteração do endereço	Datetime		N
purchaseLogged	Compra logado	boolean		N
email	E-mail de Cadastro	String	200	N
login	Login de Acesso	String	200	N

Property	Description	Type	Size	Mandatory
lastDateInsertedMail	Last email change date	Datetime		N
lastDateChangePassword	Last password change date	Datetime		N
lastDateChangePhone	Last phone change date	Datetime		N
lastDateChangeMobilePhone	Last mobile phone change date	Datetime		N
lastDateInsertedAddress	Last address change date	Datetime		N
purchaseLogged	Logged purchase (true or false)	boolean		N
email	Social network email	String	200	N
login	Social network login	String	200	N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
optInCompreConfie	Cliente aceita ingressar no movimento Compre e Confie	Integer		N
typeSocialNetwork	ID da rede social	Integer		N
authenticationToken	Token retornado pela Rede Social	String	500	N

Property	Description	Type	Size	Mandatory
optInCompreConfie	Customer agrees to join the CompreConfie movement (1 or 0)	Integer		N
typeSocialNetwork	Social network ID See the list at Social Network List	Integer		N
authenticationToken	Token of the social network	String	500	N

Objeto shipping

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
clientID	Código do cliente	String	50	N
type	Pessoa Física ou Jurídica	Integer		S
primaryDocument	CPF ou CNPJ	String	100	S
secondaryDocument	RG ou Inscrição Estadual	String	100	N
name	Nome do cliente	String	500	S
birthDate	Data de Nascimento	Datetime		N
email	Email	String	150	N
gender	Sexo	String	1	N
address	Endereço	address		S
phones	Telefones	Array<phone>		S
deliveryType	ID do Tipo de entrega	String	50	S
deliveryTime	Prazo de Entrega	String	50	N
price	Valor do Frete	Decimal	20,4	S
pickUpStoreDocument	CPF para retirada em loja (caso o pedido seja de algum tipo de entrega “Retirada”)	String	30	N

Importante: No produto Total Garantido, o envio dos dados de entrega deverá respeitar a obrigatoriedade mínima dos campos informados como ‘S’ (Objeto address), salvo exceção de regra de negócio que não exista entrega física de produtos.

Em caso de empresas de passagens aéreas o endereço de entrega não é obrigatório.

Object shipping

Property	Description	Type	Size	Mandatory
clientID	Customer ID	String	50	N
type	Natural or Legal PersonSee the list at Person Type List	Integer		Y
primaryDocument	CPF or CNPJ	String	100	Y
secondaryDocument	RG or state registration	String	100	N
name	Customer name	String	500	Y
birthDate	Customer birth date	Datetime		N
email	Email	String	150	N
gender	Gender See the list at Gender List	String	1	N
address	Object Address	address		Y
phones	Object phones	Array<phone>		Y
deliveryType	ID of the Shipping Type See the list ate Delivery types list	String	50	Y
deliveryTime	Delivery Time	String	50	N
price	Shipping Price	Decimal	20,4	Y
pickUpStoreDocument	CPF of the person who will withdraw the product in the store	String	30	N

Important: In the Total Guaranteed product, the submission of delivery data must respect the minimum mandatory requirement of the fields informed as 'S' (Object address), except for the exception of a business rule that there is no physical delivery of products.

In the case of airline ticket companies, the delivery address is not mandatory.

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
sequential	Sequência de realização do pagamento	Integer		N
date	Data do pagamento	Datetime		N
value	Valor cobrado neste pagamento	Decimal	20,4	N
type	Tipo de Pagamento	Integer		S
installments	Quantidade de Parcelas	Integer		N
interestRate	Taxa de Juros	Decimal	4,2	N
interestValue	Valor dos Juros	Decimal	20,4	N
currency	Código da moeda	Integer		N
voucherOrderOrigin	ID do pedido que gerou vale troca (caso a forma de pagamento atual seja “Vale”)	String	50	N
address	Endereço pagamento	paymentAddress		N
card	cartão	card		S

Property	Description	Type	Size	Mandatory
sequential	Number indicating the payment sequence	Integer		N
date	Payment date	Datetime		N
value	Payment value	Decimal	20,4	N
type	Payment type See the list at Payment Type List	Integer		Y
installments	Amount of installments	Integer		N
interestRate	Interest rate	Decimal	4,2	N
interestValue	Interest value	Decimal	20,4	N
currency	Currency ID See the list at Currency List	Integer		N
voucherOrderOrigin	Order ID that generated the voucher	String	50	N
address	Object paymentAddress	paymentAddress		N
card	Object card	card		Y

Objeto items

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
code	Código do Produto	String	50	N
name	Nome do Produto	String	150	S
barCode	EAN (Código de barras) do produto	String	200	N
value	Valor Unitário	Decimal	20,4	S
amount	Quantidade	Integer		N
categoryID	Código da Categoria do Produto	Integer		N
categoryName	Nome da Categoria do Produto	String	200	N
isGift	Identifica se o item é um presente (true ou false)	Boolean	-	N
sellerName	Nome fantasia do seller/parceiro	String	200	S (Se aplicável)
sellerDocument	CNPJ do seller/parceiro	String	14	S (Se aplicável)
isMarketPlace	Para informar que há dados de seller, o valor deverá ser semprer ”true”.	String	5	S (Se aplicável)
sellerSegment	Segmento do seller/parceiro.	String	200	N
shippingCompany	Nome da Transportadora	String	200	N

Importante: Em caso de empresas de passagens aéreas os dados de item não são obrigatórios.

Property	Description	Type	Tamanho	Mandatory
code	Item code	String	50	N
name	Product name	String	150	Y
barCode	EAN (bar code) of product	String	200	N
value	Item unitary value	Decimal	20,4	Y
amount	Amount of items	Integer		N
categoryID	Category ID	Integer		N
categoryName	Category Name	String	200	N
isGift	Identifies whether the product is a gift (true or false)	Boolean	-	N
sellerName	Seller name	String	200	Y (If applicable)
sellerDocument	Seller's CNPJ	String	14	Y (If applicable)
isMarketPlace	Item sold by Marketplace (inform "true" or "false")	String	5	Y (If applicable)
shippingCompany	Shipping company name	String	200	N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
name	Nome do Passageiro	String	100	S
companyMileCard	Companhia de Milhagem (Fidelidade)	String	50	N
mileCard	Cartão de Milhagem (Fidelidade)	String	50	N
identificationType	Tipo de Documento de Identificação	Integer		N
identificationNumber	Número do Documento	String	50	N
gender	Sexo do Passageiro	String	1	N
birthdate	Data de nascimento	Datetime		N
cpf	CPF do Passageiro	String	50	N

Property	Description	Type	Size	Mandatory
name	Passanger name	String	100	Y
companyMileCard	Company mile card name	String	50	N
mileCard	Number of mile card	String	50	N
identificationType	Legal document type See the list at identification List	Integer		N
identificationNumber	Legal document number	String	50	N
gender	Passager gender	String	1	N
birthdate	Passenger birth date	Datetime		N
cpf	Passenger CPF	String	50	N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
company	Nome da Companhia Aérea	String	50	N
identificationNumber	Número do Voo	Decimal	6,0	N
date	Data do Voo	Datetime		S
seatClass	Classe do Assento	String	10	S
origin	Origem	String	5	S
destination	Destino	String	5	S
boarding	Data de Embarque	Datetime		S
arriving	Data de Desembarque	Datetime		S
fareClass	Classe Tarifária	String	25	N

Property	Description	Type	Size	Mandatory
company	Name of the tourism company	String	50	N
identificationNumber	Travel number	Decimal	6,0	N
date	Travel date	Datetime		Y
seatClass	Seat class	String	10	Y
origin	Travel origin	String	5	Y
destination	Travel destination	String	5	Y
boarding	Departure date	Datetime		N
arriving	Arrival date	Datetime		N
fareClass	Fare Class	String	25	N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
name	Nome do Hotel	String	200	S
city	Cidade	String	150	S
state	Estado	String	150	S
country	País	String	150	N
reservationDate	Data da Reserva	Datetime		N
reserveExpirationDate	Data da Expiração da Reserva	Datetime		N
checkInDate	Data da Chegada	Datetime		N
checkOutDate	Data da Saída	Datetime		N

Property	Description	Type	Size	Mandatory
name	Hotel name	String	200	Y
city	city	String	150	Y
state	state	String	150	Y
country	Country	String	150	N
reservationDate	Reservation date	Datetime		N
reserveExpirationDate	Reservation expiration date	Datetime		N
checkInDate	Checkin Date	Datetime		N
checkOutDate	Checkout Date	Datetime		N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
street	Nome do logradouro	String	200	S
number	Número do Endereço	String	15	S
additionalInformation	Complemento do Endereço	String	250	N
county	Bairro do Endereço	String	150	S
city	Cidade do Endereço	String	150	S
state	Sigla do Estado do Endereço - UF	String	2	S
country	País do Endereço	String	150	S
zipcode	CEP do Endereço	String	10	S
reference	Referência do Endereço	String	250	N

Property	Description	Type	Size	Mandatory
street	Street name	String	200	Y
number	Address number	String	15	Y
additionalInformation	Address Complement	String	250	N
county	Address district	String	150	Y
city	Address city	String	150	Y
state	Address state initials	String	2	Y
country	Address country	String	150	Y
zipcode	Address zip code	String	10	Y
reference	Address reference	String	250	N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
type	Tipo de Telefone	Integer		S
ddi	DDI do Telefone	Integer	3	N
ddd	DDD do Telefone	Integer	2	S
number	Número do Telefone	Integer	9	S
extension	Ramal do Telefone	String	10	N

Property	Description	Type	Size	Mandatory
type	Phone type See the list at Phone Type List	Integer		Y
ddi	Country code	Integer	3	N
ddd	Area code	Integer	2	Y
number	Phone number	Integer	9	Y
extension	Phone extension	String	10	N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
number	Número do Cartão com Máscara	String	200	N
hash	Hash do número do cartão	String	128	N
bin	6 Primeiros Números do Cartão de Crédito	String	6	S
end	4 últimos digitos do número de cartão	String	4	S
type	Bandeira do Cartão	Integer		S
validityDate	Data da Expiração	String	50	N
ownerName	Nome de Cobrança	String	150	S
document	Documento da Pessoa de Cobrança	String	100	S
nsu	Número identificador único de uma transação de cartão	String	50	N

Property	Description	Type	Size	Mandatory
number	Bank card number	String	200	N
hash	Card number hash	String	128	N
bin	Bank card bin	String	6	Y
end	Last 4 digits of the bank card	String	4	Y
type	Flag type of the bank card See the list at BankCard Flag List	Integer		Y
validityDate	Expiration date	String	50	N
ownerName	Card holder	String	150	Y
document	Legal document of the card holder	String	100	Y
nsu	Transaction identification number of the bank card	String	50	N

HttpCode:	400 (Bad Request)
Body:	{ "Message": "The request is invalid.", "ModelState": { "< JPath_da_Propriedade >": [ "< Mensagem_Nome_Propriedade_descricao_erro > ] } }

Total - Total Garantido - Application (Novas regras para ofertas garantidas)

Total - Total Guaranteed - Application (New rules for guaranteed offers)

Introdução +

Introduction +

Etapas da Homologação +

Sandbox Steps +

Operações API +

API operations +

Autenticação do Token

Requisição

Resposta

Inclusão de Pedidos

Requisição

Resposta

Token Authentication

Request

Response

Send Orders

Request

Response

Reanálise de Pedidos

Requisição

Resposta

Re-analysis of orders

Request

Response

Notificação de alteração de status (Webhook)

Requisição

Update Status Notification

Request

Consulta de Status

Requisição

Resposta

Status Check

Request

Response

Atualização de Status

Requisição

Resposta

Status Update

Request

Response

Marcação de Chargeback

Requisição

Resposta

Chargeback Authentication

Request

Response

Tabelas código e descrição +

Appendix +

Tipo de telefone (billing/shipping.phone.type)

Phone Type List (billing/shipping.phone.type)

Tipo de identificação (passanger.identificationType)

Identification Type List

Tipo pessoa (billing/shipping.type)

Person Type (billing/shipping.type)

Tipo de sexo (billing/shipping.gender)

Gender Type (billing/shipping.gender)

Tipo de pagamento (payment.type)

Payment Type (payment.type)

Bandeira Cartão de Crédito (card.type)

Bank Card Flag List (card.type)

Lista de Status (de retorno)

Analysis Status List

Lista de Status (de entrada)

Initial Status List * (orders.status)

Status de pagamento

Statuses of Payments

Tipo de Entrega (shipping.deliveryType)

Delivery Types (shipping.deliveryType)

Tipo de listas (order.list.typeID)

List Types (order.list.typeID)

Rede Social (socialNetwork)

Social Network

Lista de produto (order.product)

Product List (order.product)

Lista de moeda (payment.currency)

Currency list (payment.currency)

Descrição de campos +

Fields Description +

Introdução

Introduction

Etapas da Homologação

Sandbox Steps

Operações API

API operations

Tabelas código e descrição

Appendix

Descrição de campos

Fields Description

Resolução de problemas

Troubleshooting