API docs by Redocly

Spedisci.online API (1.0.0)

Download OpenAPI specification:Download

E-mail: supporto@spedisci.online

Welcome to the Spedisci.Online API! You can use our API to access Spedisci.Online API endpoints, which can get information on various data in your account (Tracking, Rates, Credit, etc) , and access to create specific objects, like Orders, Shippings Labels, and Reports..

Find out more about Spedisci.online

shipping

Rates,Create, Print

Get Rates

Get shipping rates and carriers contracts available.

Authorizations:
qCL7FN2RKFQDngWb6kJ7fwxfF1yXQt6lNLN32K1tdNxVNnpBWL4qoOEWVJ8e
Request Body schema:

json

required
Array of objects non-empty unique
required
object
required
object
notes
required
string non-empty
insuranceValue
required
number
codValue
required
number
accessoriServices
required
Array of strings

Responses

Request samples

Content type
{
  • "packages": [
    ],
  • "shipFrom": {
    },
  • "shipTo": {
    },
  • "notes": "test api",
  • "insuranceValue": 0,
  • "codValue": 0,
  • "accessoriServices": [ ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create Label

Creates a shipping label. The labelData field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label. The body of this request has the following attributes:

Authorizations:
qCL7FN2RKFQDngWb6kJ7fwxfF1yXQt6lNLN32K1tdNxVNnpBWL4qoOEWVJ8e
Request Body schema:

json

carrierCode
required
string non-empty
contractCode
required
string non-empty
required
Array of objects (Package) non-empty unique [ items ]
required
object (Address)
required
object (Address)
notes
required
string non-empty
insuranceValue
required
number
codValue
required
number

Cash on delivery value.

accessoriServices
required
Array of objects
label_format
string

"PDF" or "ZPL"

Responses

Request samples

Content type
{
  • "carrierCode": "brt",
  • "contractCode": "brt-Test",
  • "packages": [
    ],
  • "shipFrom": {
    },
  • "shipTo": {
    },
  • "notes": "test api",
  • "insuranceValue": 0,
  • "codValue": 0,
  • "accessoriServices": [ ],
  • "label_format": "PDF"
}

Response samples

Content type
{
  • "shipmentId": 4454058,
  • "trackingNumber": "DEMO05407027",
  • "shipmentCost": "7.00",
  • "packages": [
    ],
  • "labelData": "JVBERi0xLjcKMyAwIG9iago8PC9Ue.......",
  • "labelZPL": "XlhBCgpeRlggQ29tcGFueSBOYW1lIH......."
}

Delete Label

Delete a shipping label

Authorizations:
qCL7FN2RKFQDngWb6kJ7fwxfF1yXQt6lNLN32K1tdNxVNnpBWL4qoOEWVJ8e
Request Body schema:

json

increment_id
required
integer

Responses

Request samples

Content type
{
  • "increment_id": 230432
}

Close Day

Authorizations:
qCL7FN2RKFQDngWb6kJ7fwxfF1yXQt6lNLN32K1tdNxVNnpBWL4qoOEWVJ8e
Request Body schema: application/json
shipment_ids
required
Array of numbers
contract_code
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "shipment_ids": [
    ],
  • "contract_code": "brt-Test"
}

Response samples

Content type
application/json
{
  • "bordero": 163273,
  • "pdf": "JVBERi"
}

stocks

Update shippings locked in stock

Update Stock

Update shipping locked in stock. You can choose for "action" between: "RETRY","NEWADDRESS" or "RETURN". For "NEWADDRESS" action the "newaddress" object is also requi red.

Authorizations:
qCL7FN2RKFQDngWb6kJ7fwxfF1yXQt6lNLN32K1tdNxVNnpBWL4qoOEWVJ8e
Request Body schema: application/json
ldv
required
string non-empty
action
required
string non-empty
scheduled_at
required
string non-empty
object
note
string

Responses

Request samples

Content type
application/json
{
  • "ldv": "281095I072409",
  • "action": "NEWADDRESS",
  • "scheduled_at": "26/06/2021",
  • "newaddress": {
    },
  • "note": "please call"
}

tracking

This endpoint retrieves tracking details of a shipping by trackingNumber.

Tracking

Authorizations:
qCL7FN2RKFQDngWb6kJ7fwxfF1yXQt6lNLN32K1tdNxVNnpBWL4qoOEWVJ8e
path Parameters
ldv
required
string

Responses

Response samples

Content type
application/json
{
  • "TrackingDettaglio": [
    ]
}