API Boxlink

Expedir uma Lista de Rastreadores

Ambiente de Produção

https://api.boxlink.com.br

POST

https://api.boxlink.com.br/dispatch

Este endpoint serve para expedir informando uma lista de rastreadores da boxlink

Request

Header Params

Authorization

string

required

Example:

Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJldmFyZWxhQGdyYW5hZG9waGViby5jb20uYnIiLCJVU0VSX0RFVEFJTFMiOnsidXNlcklkIjoyNzg4LCJtYXRyaXpJZCI6MjgsImZyYW5xdWlhSWQiOjEsImNsaWVudGVJZCI6bnVsbH0sImV4cCI6MjIwODkxMzIwMH0.iwGJYTmRlqIr1zU9p1OneB2WhbB6JKvBYbFRnWlPzfI

Content-Type

string

required

Example:

application/json

Body Params application/json

dispatchDateTime

string

optional

rastreadorTmsList

array[string]

required

Example

{
	"dispatchDateTime": "2024-05-18 18:22:23",
	"rastreadorTmsList": [
		"BLK79000D7949"
	]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.boxlink.com.br/dispatch' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJldmFyZWxhQGdyYW5hZG9waGViby5jb20uYnIiLCJVU0VSX0RFVEFJTFMiOnsidXNlcklkIjoyNzg4LCJtYXRyaXpJZCI6MjgsImZyYW5xdWlhSWQiOjEsImNsaWVudGVJZCI6bnVsbH0sImV4cCI6MjIwODkxMzIwMH0.iwGJYTmRlqIr1zU9p1OneB2WhbB6JKvBYbFRnWlPzfI' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
	"dispatchDateTime": "2024-05-18 18:22:23",
	"rastreadorTmsList": [
		"BLK79000D7949"
	]
}'

Responses

🟢200OK

application/json

Body

resource

string

required

date

string

required

success

boolean

required

exceptions

array [object {2}]

required

string

optional

message

string

optional

data

string

required

Examples

SuccessException

{
    "resource": "http://localhost:8080/dispatch",
    "date": "2024-06-21T11:59:19.876746900",
    "success": true,
    "exceptions": [],
    "data": {
        "dispatchLotId": "9e6f5539-ba1c-4d82-bd07-7e1e6193a66b"
    }
}

Expedir uma Triagem

Chamar novamente a trasportadora da loja