Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Como atualizar a Clique Retire a respeito de algum evento ocorrido no processo.
POST https://services.cliqueretire.com.br/webhook/api/v1/volume-tracking
Descrição de como enviar a notificação do tracking de um volume para a Clique Retire.
Eventos relacionados a apenas 1 (um) volume.
Volume expirado, coletado pela transportadora
FOR_MERCHANT_STORE_COURIER_TAKEN_IN_BOUND
Volume expirado, coletado pela transportadora, retornado para o centro de distribuição Clique Retire
FOR_MERCHANT_STORE_CUSTOMER_TAKEN
Volume coletado pelo usuário
FOR_MERCHANT_STORE_IN_STORE_EXPIRED
Tempo do volume no E-BOX expirado
FOR_MERCHANT_STORE_IN_STORE_UPCOMING_EXPIRED
Tempo do volume no E-BOX prestes a expirar
FOR_CUSTOMER_STORE_IN_STORE
Inserido no E-BOX pelo usuário. (Logística Reversa)
FOR_CUSTOMER_STORE_COURIER_TAKEN
Coletado no E-BOX pela transportadora (Logística Reversa)
FOR_CUSTOMER_STORE_IN_BOUND
No centro de distribuição Clique Retire
Content-Type
string
application/json
api-id
string
api-key
string
expressNumber
string
Código da etiqueta do pacote
statusTimestamp
integer
Data de ocorrência do evento no formato timestamp
event
string
Evento relacionado a ocorrência do tipo ENUM conforme tabela Eventos Disponíveis.
Events
Description
ORIGIN_COLLECTED
Coletado no centro de distribuição do embarcador
CARRIER_DISTRIBUTION_CENTER
No centro de distruibuição da transportadora
FOR_MERCHANT_STORE_IN_BOUND
No centro de distribuição Clique Retire
FOR_MERCHANT_STORE_IN_TRANSIT_TO_STORE
A caminho do E-BOX
FOR_MERCHANT_STORE_IN_STORE
Inserido no E-BOX
{
"status": "success",
"message": "Envio recebido com sucesso",
"hash": "09ef7f90-2e55-11ea-8baf-0d73fdad3a02"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Unauthorized"
}{
"status": "error",
"message": "Volume not found",
"hash": "09ef7f90-2e55-11ea-8baf-0d73fdad3a02"
}FOR_MERCHANT_STORE_COURIER_TAKEN
Documentação para acessar API da CliqueRetire
O Objetivo dessa documentação é apresentar de maneira rápida e objetiva como desenvolver uma integração com a Clique Retire. Os serviços disponíveis em nossa API estão exibidos no menu a esquerda e descrição de cada parâmetro assim como exemplos de uso estão disponiveís internamente em cada item.
Está API utiliza requisições HTTP GET, POST, DELETE e o formato JSON para transferência de dados
Server error
Code
Description
400
Parameter error
401
UserToken expired or Invalid
403
User does not have permission
404
Resource not found
409
Conflict or already exists
500
Como solicitar que a transportadora Clique Retire faça a coleta de remessas.
header: {
Content-Type: application/json,
api-id: string,
api-key: string
}origin_state_tax_payer_id
string
Inscrição estadual
origin_street
string
Endereço e número
origin_zip_code
string
CEP
shipment_date
string
Data de coleta
shipment_order_array
array
Array de pedidos
Array nota fiscal
Data emissão nota fiscal(DDMMYYYY)
invoice_key
Chave nota fiscal
invoice_nature
Natureza nota fiscal
invoice_number
Número nota fiscal
invoice_products_value
Valor dos produtos na nota fiscal
invoice_series
Série da nota fiscal
Content-Type
string
application/json
api-id
string
api-key
string
string
origin_city
string
Cidade de Origem
origin_name
string
Razão social empresa
origin_state_code
string
UF
Fields
Description
externalId
Identificador do pedido do embarcador
boxCode
Código único do E-BOX
customer
Objeto com informações do usuário
shipment_order_volume_array
Array com volumes
Fields
Descripton
cellphone
5521999999999
barackobama@gmal.com
Field
Description
height
Altura
length
Comprimento
weight
Peso
width
Largura
shipment_order_volume_number
Código de barras do pacote
Field
Description
already_insured
Carga assegurado (bool)
cubage
Cubagem
icms_aliquot
Alíquota icms
icms_calculation_basis
Base de cálculo icms
invoice_cfop
CFOP Nota fiscal
{
"id": "string"
}shipment_order_volume_invoice_array
invoice_date_iso
Recursos relacionados a volumes.
GET https://services.cliqueretire.com.br/ebox/api/v1/volumes
Listar volumes cadastrados
GET https://services.cliqueretire.com.br/ebox/api/v1/volumes_by_expressNumber/:expressNumber
Busca informações de um volume utilizando o código da etiqueta
DELETE https://services.cliqueretire.com.br/ebox/api/v1/volumes
Cancela um volume através de seu expressNumber
Recursos relacionados aos E-BOX
POST https://services.cliqueretire.com.br/ebox/api/v1/lockers/check_volume_fits
Essa consulta pode ser utilizada pelo embarcador no momento em que os produtos estão no carrinho de compras para verificação da compatibilidade entre o tamanho dos pacotes e o tamanho suportado pelos compartimentos do Locker para receber o produto.
Content-Type
string
application/json
api-id
string
api-key
string
appllication/
expressNumber
string
Código da etiqueta do pacote
Content-Type
string
application/json
api-id
string
api-key
string
expressNumber
string
Código da etiqueta do pacote
Content-Type
string
application/json
api-id
string
api-key
string
{
"page": 0,
"maxCount": 10,
"totalPage": 1,
"totalCount": 1,
"resultList": [
{
"id": "ba3678c1-b313-4b62-9a91-cc5933c5145c",
"expressNumber": "CODE",
"orderNumber": "CODE",
"status": "EBOX_STORED ",
"lastModifiedTime": 1591030157347,
"expressType": "Delivery",
"accessCode": "CODE",
"shortLink": "http://cr2.me/CODE",
"storeUser": {
"storeBy": "ISENT",
"storeUserId": "d37c7a23-32a5-467c-a069-d6a0076b772e",
"storeUserPhone": "+55 21 99999-9999"
},
"box": {
"name": "Posto Suburbano",
"boxCode": "CR0078",
"type": "M"
},
"endCustomer ": {
"celPhone": "5521999999999",
"email": "barack.obama@gmail.com",
"fullName": "5521999999999"
},
"storeTime": "2020-06-01T13:49:00-03:00",
"takeTime": null,
"overdueTime": "2020-06-04T23:00:00-03:00",
"createTime": 1590751945000,
"logisticsCompany": {
"id": "ab0e7975-e65f-483b-a868-9195ec179182",
"name": "FEDEX Entregas"
},
"importUser": {
"name": "Clique Retire API",
"id": "8a7ee4856e66988c016e8f26436f05fe",
"loginName": "cliqueRetireApi"
},
"overdueFlag": false
}
]
}{
"message": "Unauthorized"
}{
"id": "ba3678c1-b313-4b62-9a91-cc5933c5145c",
"expressNumber": "CODE",
"orderNumber": "CODE",
"status": "EBOX_STORED ",
"lastModifiedTime": 1591030157347,
"expressType": "Delivery",
"accessCode": "CODE",
"shortLink": "http://cr2.me/CODE",
"storeUser": {
"storeBy": "ISENT",
"storeUserId": "d37c7a23-32a5-467c-a069-d6a0076b772e",
"storeUserPhone": "+55 21 99999-9999"
},
"box": {
"name": "Posto Suburbano",
"boxCode": "CR0078",
"type": "M"
},
"endCustomer ": {
"celPhone": "5521999999999",
"email": "barack.obama@gmail.com",
"fullName": "5521999999999"
},
"storeTime": "2020-06-01T13:49:00-03:00",
"takeTime": null,
"overdueTime": "2020-06-04T23:00:00-03:00",
"createTime": 1590751945000,
"logisticsCompany": {
"id": "ab0e7975-e65f-483b-a868-9195ec179182",
"name": "FEDEX Entregas"
},
"importUser": {
"name": "Clique Retire API",
"id": "8a7ee4856e66988c016e8f26436f05fe",
"loginName": "cliqueRetireApi"
},
"overdueFlag": false
}{
"message": "Unauthorized"
}"Volume not found"{
"message": "Unauthorized"
}{
"errorMessage": "Express not found",
"reference": "offline_awsRequestId_ckaws7oed000n64spfm99cwf2"
}Content-Type
string
application/json
api-id
string
string
api-key
string
string
boxCode
string
Código do E-BOX
volumes
array
Volumes que deseja consultar compatibilidade com o locker
{
"volumes": [
{
"ref_id": "box1",
"compatible": true,
"lockers": [
{
"type": "M",
"width": 34.2,
"heigth": 18.8,
"depth": 47.2,
"price": 5,
"used": 2,
"enable": 8
},
{
"type": "L",
"width": 34.2,
"heigth": 39.1,
"depth": 47.2,
Informações do volume (*)Required
Field
Description
externalId
Id para Referência do volume no sistema do embarcador
width*
Largura do volume em cm
heigth*
Altura do volume em cm
depth*
Profundidade do volume em cm
GET https://services.cliqueretire.com.br/ebox/api/v1/lockers/site
Recursos público para consulta de listagem de E-BOX disponíveis na rede Clique Retire
Content-Type
string
application/json
GET https://services.cliqueretire.com.br/ebox/api/v1/lockers/export/csv
Recurso público para consulta de listagem de E-BOX disponíveis na rede Clique Retire no formato CSV.
Content-Type
string
application/json
GET https://services.cliqueretire.com.br/ebox/api/v1/lockers/boxCode/:boxCode
Informações do E-BOX e de seus compartimentos
boxCode
string
Código único do E-BOX
Content-Type
string
application/json
api-id
string
api-key
string
Content-Type
string
application/json
api-id
string
api-key
string
[
{
"created_at": "2019-12-26T12:12:56.281Z",
"company": "CLIQUERETIRE",
"customer": {
"cellphone"5521966940535",
"sprm.saulo@gmail.com",
},
"orderId": "DRZIMY",
"status": "IMPORTED",
"volumes": [
{
"expressNumber": "JN424467840BR",
"id": "8a7ee4856f09ccfe016f421fc63d3742",
"external_id": "8a7ee4856f09ccfe016f421fc63d3742"
}
],
"id": "0cb53490-27d9-11ea-8dc5-09031cbbcbea",
GET https://services.cliqueretire.com.br/ebox/api/v1/orders/:id
Busca informações de um pedido, utilizando o id do pedido.
id
string
Id do pedido
Content-Type
string
application/json
api-id
string
api-key
string
POST https://services.cliqueretire.com.br/ebox/api/v1/orders
Cria um pedido com seus pacotes
Content-Type
string
application/json
api-id
string
api-key
string
invoice
object
Objeto com dados da nota fiscal
externalId
string
Identificador do pedido do embarcador
customer
object
Informações do destinatário
boxCode
string
Código do E-BOX
Informações do destinatário. (*) Required
Field
Description
cellphone*
Telefone do destinatário (5521999999999)
email*
string
fullName
string
documentNumber
string
Informações do volume (*)Required
Field
Description
expressNumber*
Código de barras do pacote
designationSize
ENUM ["S", "M", "L"]
externalId
string
Informações da nota fiscal (*)Required
Field
Description
series
Número de série da nota fiscal
number
Número da nota fiscal
key
Chave da nota fiscal
date
Data de emissão da nota fiscal
dateIso
Data de emissão da nota fiscal formato ISO
POST https://services.cliqueretire.com.br/ebox/api/v1/orders/return
Criação de pedidos com volumes para logística reversa.
Application-Type
string
application/json
api-id
string
string
api-key
string
string
invoice
string
Objeto com dados da nota fiscal
externalId
string
Identificador do pedido do embarcador
customer
string
Informações do destinatário
boxCode
string
Código do E-BOX
Informações do destinatário. (*) Required
Field
Description
cellphone*
Telefone do destinatário (5521999999999)
email*
string
fullName
string
documentNumber
string
Informações do volume (*)Required
Field
Description
expressNumber*
Código de barras do pacote
designationSize
ENUM ["S", "M", "L"]
externalId
string
Informações da nota fiscal
Field
Description
series
Número de série da nota fiscal
number
Número da nota fiscal
key
Chave da nota fiscal
date
Data de emissão da nota fiscal
dateIso
Data de emissão da nota fiscal formato ISO
DELETE https://services.cliqueretire.com.br/ebox/api/v1/orders/:id
Deleta um pedido
id
string
Id do pedido
Content-Type
string
application/json
api-id
string
string
api-key
string
string
{
"message": "Unauthorized"
}{
"maxCount": 100,
"page": 0,
"resultList": [
{
"instructions": {
"pickup": "Insira o código ou aproxime o QR code do leitor",
"receipt": "Insira o código ou aproxime o QR code do leitor"
},
"boxCode": "CR0071",
"working_hours": {
"sunday": {
"start": "05:00",
"end": "23:59"
},
"saturday": {
"start": "05:00",
"end": "23:59"
},
"tuesday": {
"start": "05:00",
"end": "23:59"
},
"friday": {
"start": "05:00",
"end": "23:59"
},
"thursday": {
"start": "05:00",
"end": "23:59"
},
"wednesday": {
"start": "05:00",
"end": "23:59"
},
"holiday": {
"start": "05:00",
"end": "23:59"
},
"monday": {
"start": "05:00",
"end": "23:59"
}
},
"name": "Estação República L4 - Disponível a partir de 20/3/2020",
"warehouse_location": {
"reference": "N/C",
"additional_information": "Ao chegar procurar um funcionário da Clique Retire.",
"number": "470",
"city": "São Paulo",
"street": "Rua Charles Darwin",
"latitude": "-23.655119",
"neighborhood": "Vila Santa Catarina",
"state": "SP",
"zip_code": "04379-074",
"longitude": "-46.6598096"
},
"location": {
"reference": "Estação República L4",
"additional_information": "Metrô CCR",
"number": "24",
"street": "Rua do Arouche,",
"latitude": -23.5431042,
"zip_code": "22070011",
"longitude": -46.6440237
},
"facilities": {
"parking": "false",
"close_to_subway": "true",
"free_parking": "false",
"accessibility": "true",
"air_conditioned": "true"
},
"operator": "WFRETES",
"group": "MetroSaoPaulo"
},
{
"instructions": {
"pickup": "Utilize o QR Code recebido para retirar sua encomenda.",
"receipt": "Utilize o QR Code recebido para retirar sua encomenda."
},
"boxCode": "CR0001",
"working_hours": {
"sunday": {
"start": "07:00",
"end": "23:00"
},
"saturday": {
"start": "05:00",
"end": "23:00"
},
"tuesday": {
"start": "05:00",
"end": "23:00"
},
"friday": {
"start": "05:00",
"end": "23:00"
},
"thursday": {
"start": "05:00",
"end": "23:00"
},
"wednesday": {
"start": "05:00",
"end": "23:00"
},
"holiday": {
"start": "07:00",
"end": "23:00"
},
"monday": {
"start": "05:00",
"end": "23:00"
}
},
"name": "Estação Jardim Oceânico",
"warehouse_location": {
"reference": "Estação de metrô estácio",
"additional_information": "Ao chegar na estação procurar um funcionário da Clique Retire.",
"number": "15",
"city": "Rio de Janeiro",
"street": "R. Ulysses Guimarães",
"latitude": "-22.9134908",
"neighborhood": "Cidade Nova",
"state": "RJ",
"zip_code": "20211-225",
"longitude": "-43.206488"
},
"location": {
"reference": "Estação Jardim Oceânico",
"additional_information": "Plataforma: 1 (Desembarque), abaixo da última escada",
"number": "S/N",
"street": "N/D",
"latitude": -23.0068073,
"zip_code": "22640-100",
"longitude": -43.3109288
},
"facilities": {
"parking": false,
"close_to_subway": true,
"free_parking": false,
"accessibility": false,
"air_conditioned": true
},
"operator": "WFRETES",
"group": "MetroRio"
}
]
}{
"id": "0bf28187-a11e-4ef2-8a56-30a6b87d3a03",
"name": "BLE Test Rio",
"boxCode": "BLE001",
"compartmentList": [
{
"compartmentId": "61d73888-7284-464a-b5e4-c16882dd5820",
"compartmentTypeId": "d092725609ab11e58bdb0242ac110001",
"name": "A1",
"compartmentStatus": "OCCUPIED",
"shipment": {
"ordersId": "ce9b30ff-760a-48f6-8b93-f8dbbc074d2d",
"trackingNumber": "BLETEST13",
"serviceType": "Delivery",
"companyName": "WFRETES",
"storeTime": "2020-03-11T16:21:29-03:00"
}
},
{
"compartmentId": "feb7fa35-4d3f-4ec5-a89e-89495061167b",
"compartmentTypeId": "d092725609ab11e58bdb0242ac110001",
"name": "A2",
"compartmentStatus": "AVAILABLE",
"shipment": null
},
{
"compartmentId": "44da6d96-b40a-4ac2-a143-0b7ccaf65882",
"compartmentTypeId": "d092725609ab11e58bdb0242ac110001",
"name": "A3",
"compartmentStatus": "AVAILABLE",
"shipment": null
}
],
"status": {
"S": {
"LOCKED": 1,
"ENABLE": 2
}
}
}{
"message": "Unauthorized"
}{
"message": "Unauthorized"
}{
"created_at": "2019-12-26T12:12:56.281Z",
"company": "CLIQUERETIRE",
"takeUserPhoneNumber": "5521966940535",
"orderId": "DRZIMY",
"status": "IMPORTED",
"takeUserMail": "sprm.saulo@gmail.com",
"volumes": [
{
"expressNumber": "JN424467840BR",
"id": "8a7ee4856f09ccfe016f421fc63d3742"
}
],
"id": "0cb53490-27d9-11ea-8dc5-09031cbbcbea",
"boxCode": "CR0040"
}{
"message": "Unauthorized"
}{
"id": "string"
}{
"message": "Unauthorized"
}{
"id": "string"
}{
"message": "Unauthorized"
}{
"message": "Unauthorized"
}volumes
array
Volumes associados a esse pedido
urlCallback
string
URL para qual o webHook irá disparar os eventos relacionados ao pedido
totalValue
Valor total da nota fiscal
productsValue
Valor total dos produtos
insured
Produto assegurado
volumes
string
Volumes associados a esse pedido
urlCallback
string
URL para qual o webhook irá disparar eventos relacionados aos pedidos
totalValue
Valor total da nota fiscal
productsValue
Valor total dos produtos
insured
Produto assegurado
Código único do E-BOX
createTime
Data de geração
logisticsCompany
Nome da empresa
Content-Type
string
application/json
api-id
string
api-key
string
data
array
Informação dos pacotes
type
string
Tipo dos pacotes. DELIVERYou RETURN
Field
Description
name
Nome do usuário
barCode
Código de barras do volume
phoneNumber
Telefone celular do usuário
boxAddress
Endereço do E-BOX
boxZipCode
CEP do E-BOX
{
data: "ENCODED BASE64 PDF"
}{
"message": "Unauthorized"
}boxCode
origin_street
string
Endereço e número
origin_zip_code
string
CEP
shipment_date
string
Data de coleta
shipment_order_array
string
Array de pedidos
Array nota fiscal
Data emissão nota fiscal(DDMMYYYY)
invoice_key
Chave nota fiscal
invoice_nature
Natureza nota fiscal
invoice_number
Número nota fiscal
invoice_products_value
Valor dos produtos na nota fiscal
invoice_series
Série da nota fiscal
Authorization
string
origin_city
string
Cidade de origem
origin_name
string
Razão social empresa
origin_state_code
string
UF
origin_state_tax_payer_id
string
Inscrição estadual
Field
Description
externalId
Identificador do pedido do embarcador
boxCode
Código único do E-BOX
customer
Objeto com informações do usuário
shipment_order_volume_array
Array com volumes
Field
Descripti
cellphone
5521999999999
barackobama@gmal.com
Field
Description
height
Altura
length
Comprimento
weight
Peso
width
Largura
shipment_order_volume_number
Código de barras do pacote
Field
Description
already_insured
Carga assegurado (bool)
cubage
Cubagem
icms_aliquot
Alíquota icms
icms_calculation_basis
Base de cálculo icms
invoice_cfop
CFOP Nota fiscal
shipment_order_volume_invoice_array
invoice_date_iso
Como receber atualizações do tracking de volumes através do webhook Clique Retire
POST https://sua-url.com/
Esse recurso trata-se de um Webhook que oferece o envio de informações relacionadas aos eventos de rastreamento para sistemas terceiros integrados. A URL para o recebimento do evento precisa ser informada no momento da criação do pedido ou através do nosso canal de suporte. Todos os eventos enviados são sempre relacionados a 1 (um) volume.
overdueTimeStamp
integer
Data de expiração do volume no E-BOX
customer
string
Usuário final
boxCode
string
Código único do E-BOX
event
string
Evento
Volume expirado, coletado pela transportadora
FOR_MERCHANT_STORE_COURIER_TAKEN_IN_BOUND
Volume expirado, coletado pela transportadora, retornado para o centro de distribuição Clique Retire
FOR_MERCHANT_STORE_CUSTOMER_TAKEN
Volume coletado pelo usuário
FOR_MERCHANT_STORE_IN_STORE_EXPIRED
Tempo do volume no E-BOX expirado
FOR_MERCHANT_STORE_IN_STORE_UPCOMING_EXPIRED
Tempo do volume no E-BOX prestes a expirar
FOR_CUSTOMER_STORE_IN_STORE
Inserido no E-BOX pelo usuário. (Logística Reversa)
FOR_CUSTOMER_STORE_COURIER_TAKEN
Coletado no E-BOX pela transportadora (Logística Reversa)
FOR_CUSTOMER_STORE_IN_BOUND
No centro de distribuição Clique Retire
expressNumber
string
Código de barras do volume
eventTimeStamp
integer
Data de ocorrência do evento
accessCode
string
Código para retirar o volume do E-BOX
shortLink
string
Link contendo o QR Code para retirar o volume do E-BOX
Fields
Description
ORIGIN_COLLECTED
Coletado no centro de distribuição do embarcador
CARRIER_DISTRIBUTION_CENTER
No centro de distruibuição da transportadora
FOR_MERCHANT_STORE_IN_BOUND
No centro de distribuição Clique Retire
FOR_MERCHANT_STORE_IN_TRANSIT_TO_STORE
A caminho do E-BOX
FOR_MERCHANT_STORE_IN_STORE
Inserido no E-BOX
Fields
Description
cellPhone
Celular do usuário
Email do usuário
FOR_MERCHANT_STORE_COURIER_TAKEN