API docs by Redocly

Shipzip API (v1)

Download OpenAPI specification:Download

Shipzip API helps you manage your international shipments through a programmatic interface.

An authentication based on the HTTP header is used. You must contact info@shipzip.com to complete your registration before integration and you will be given a username and password to use with the API. Since IP restrictions are applied to unauthorized resources, you also need to provide the internet IP addresses of your services.

Auth

Authentication related API operations

/api/Auth/login

Authorizations:
Bearer
Request Body schema:
userName
string or null
password
string or null

Responses

Request samples

Content type
{
  • "userName": "string",
  • "password": "string"
}

Consignments

Consignment related API operations

/api/Consignments

Creates a new consignment with given shipments

Authorizations:
Bearer
Request Body schema:
awbNumber
required
string non-empty

AWB number

consignmentDate
required
string <date-time>

Consignment Date (Default DateTime.Now)

dimensionUnits
required
string (DimensionUnitType)
Value: "cm"
width
required
number <double> >= 0.01

Width (cm)

length
required
number <double> >= 0.01

Length (cm)

height
required
number <double> >= 0.01

Height (cm)

volume
required
number <double>

Volume - The Value [Width * Length * Height] must be greater than 0

totalWeight
required
number <double>

Weight (kg) - The weight must be greater than 0

weightUnits
required
string (WeightUnitType)
Value: "kg"

Responses

Request samples

Content type
{
  • "awbNumber": "235-2024-0408",
  • "consignmentDate": "DateTime.Now",
  • "dimensionUnits": "cm",
  • "width": 15.1,
  • "length": 25.25,
  • "height": 10.38,
  • "volume": 0,
  • "totalWeight": 1.2,
  • "weightUnits": "kg"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Consignments/{id}

Shows details of consignment

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Consignments/{id}

Updates consignment with given parameters

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema:
object (ConsignmentContact)
object (ConsignmentContact)
consignmentId
string or null

Consignment Id

awbNumber
string or null

AWB number

consignmentDate
string <date-time>

Consignment Date (Default DateTime.Now)

dimensionUnits
string (DimensionUnitType)
Value: "cm"
width
number <double>

Width (cm)

length
number <double>

Length (cm)

height
number <double>

Height (cm)

volume
number <double>

Volume - The Value [Width * Length * Height] must be greater than 0

totalWeight
number <double>

Weight (kg) - The weight must be greater than 0

weightUnits
string (WeightUnitType)
Value: "kg"
Array of objects or null (TrackingAction)

Tracking Steps

shipments
Array of strings or null

Shipments

Responses

Request samples

Content type
{
  • "forwarder": {
    },
  • "receiver": {
    },
  • "consignmentId": "C010000005",
  • "awbNumber": "235-2024-0408",
  • "consignmentDate": "DateTime.Now",
  • "dimensionUnits": "cm",
  • "width": 15.1,
  • "length": 25.25,
  • "height": 10.38,
  • "volume": 0,
  • "totalWeight": 1.2,
  • "weightUnits": "kg",
  • "trackingActions": [
    ],
  • "shipments": [
    ]
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Consignments/{id}

Deletes consignment

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "value": "string",
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Consignments/{id}

Shows details of consignment

Authorizations:
Bearer
Request Body schema:
awbNumber
string or null
shipmentId
string or null
consignmentStartDate
string or null <date-time>
consignmentEndDate
string or null <date-time>

Responses

Request samples

Content type
{
  • "awbNumber": "string",
  • "shipmentId": "string",
  • "consignmentStartDate": "2019-08-24T14:15:22Z",
  • "consignmentEndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Consignments/{id}/AddShipment

Adds shipment to consignment

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema:
shipmentId
required
string non-empty

Shipment reference id

Responses

Request samples

Content type
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Consignments/{id}/RemoveShipment

Removes shipment from consignment

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema:
shipmentId
required
string non-empty

Shipment reference id

Responses

Request samples

Content type
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Consignments/awb/{id}

Get details of consignment by awb number

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

Docs

Documents related API operations

/api/Docs/PrintLastMileLabel

Confirms selected rate for last mile delivery and returns label file URL

Authorizations:
Bearer
Request Body schema:
shipmentId
required
string non-empty

Shipment reference id

Responses

Request samples

Content type
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Docs/PrintProformaInvoice

Returns proforma file URL

Authorizations:
Bearer
Request Body schema:
shipmentId
required
string non-empty

Shipment reference id

Responses

Request samples

Content type
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Docs/PrintConsignment

Returns consignment file URL

Authorizations:
Bearer
Request Body schema:
consignmentId
required
string non-empty

Consignment reference id

Responses

Request samples

Content type
{
  • "consignmentId": "con_43647677"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

Pickups

Pickup related API operations

/api/Pickups

Creates a new pickup with given parameters

Authorizations:
Bearer
Request Body schema:
shipmentId
required
string non-empty

Shipment reference id

pickupTime
required
string <date-time>

Pick-up time (UTC - ISO 8601)

groupRefId
string or null

Pickup group reference id

Responses

Request samples

Content type
{
  • "shipmentId": "shp_100300302304",
  • "pickupTime": "2024-01-27T12:00:00Z",
  • "groupRefId": "GOODS20240127"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Pickups/{id}

Shows details of pickup

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Pickups/{id}

Deletes pickup. Can only be called if pick-up operation is not started

Authorizations:
Bearer
Request Body schema:
id
required
string non-empty
explanation
required
string [ 1 .. 1500 ] characters

Responses

Request samples

Content type
{
  • "id": "string",
  • "explanation": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Pickups/Search

Search can be done either by GroupRefId or StartTime and EndTime

Authorizations:
Bearer
Request Body schema:
groupRefId
string or null

Pickup group reference id

startTime
string or null <date-time>

StartTime (UTC - ISO 8601)

endTime
string or null <date-time>

EndTime (UTC - ISO 8601)

Responses

Request samples

Content type
{
  • "groupRefId": "GOODS20240127",
  • "startTime": "2024-01-27T12:00:00Z",
  • "endTime": "2024-01-27T12:00:00Z"
}

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

Shipments

Shipment related API operations (like create, update, delete etc.)

/api/Shipments

Creates a new shipment with default rate and generates an id for reference

Authorizations:
Bearer
Request Body schema:
required
object (SenderContactInfo)

Sender Contact Info

required
object (ReceiverContactInfo)

Receiver Contact information

description
required
string non-empty

Gives the receiver information about the parcel in tracking emails. This should be human readable and meaningful (e.g. "Cat Socks Order #143", not just "#143").

fromCountry
required
string (CountryCodeType)
Enum: "AL" "DZ" "AD" "AR" "AU" "AT" "AZ" "BH" "BD" "BE" "BA" "BR" "BG" "CM" "CA" "CL" "CN" "CO" "CR" "HR" "CY" "CZ" "DK" "DD" "EC" "EG" "SV" "EE" "FI" "FR" "DE" "GH" "GR" "HN" "HK" "HU" "IS" "IN" "ID" "IQ" "IE" "IL" "IT" "JM" "JP" "JO" "KZ" "KE" "KW" "KG" "LV" "LB" "LS" "LY" "LI" "LT" "LU" "MK" "MG" "MY" "MV" "MT" "MH" "MX" "MD" "MC" "MA" "NP" "NL" "NZ" "NG" "NO" "OM" "PK" "PA" "PG" "PY" "PE" "PH" "PL" "PT" "QA" "RO" "SA" "SN" "RS" "SC" "SL" "SG" "SK" "SI" "ZA" "ES" "LK" "SE" "CH" "TW" "TT" "TN" "TR" "TC" "UA" "AE" "UK" "UZ" "VE" "ZW" "US" "PR" "ME" "KR"
toCountry
required
string (CountryCodeType)
Enum: "AL" "DZ" "AD" "AR" "AU" "AT" "AZ" "BH" "BD" "BE" "BA" "BR" "BG" "CM" "CA" "CL" "CN" "CO" "CR" "HR" "CY" "CZ" "DK" "DD" "EC" "EG" "SV" "EE" "FI" "FR" "DE" "GH" "GR" "HN" "HK" "HU" "IS" "IN" "ID" "IQ" "IE" "IL" "IT" "JM" "JP" "JO" "KZ" "KE" "KW" "KG" "LV" "LB" "LS" "LY" "LI" "LT" "LU" "MK" "MG" "MY" "MV" "MT" "MH" "MX" "MD" "MC" "MA" "NP" "NL" "NZ" "NG" "NO" "OM" "PK" "PA" "PG" "PY" "PE" "PH" "PL" "PT" "QA" "RO" "SA" "SN" "RS" "SC" "SL" "SG" "SK" "SI" "ZA" "ES" "LK" "SE" "CH" "TW" "TT" "TN" "TR" "TC" "UA" "AE" "UK" "UZ" "VE" "ZW" "US" "PR" "ME" "KR"
serviceType
required
string (ServiceType)
Value: "AirExpress"
carrierCode
required
string (CarrierCodeType)
Enum: "Usps" "Fedex" "YK"
shipmentType
required
string (ShipmentType)
Enum: "Box" "Document" "Packet" "Pallet" "Crate"
object (ParcelInfo)

Parcel Info

customsDeclaration
required
string (CustomsDeclarationType)
Enum: "Courier" "Etgb" "Export" "Import"
Array of objects or null (Content)

Contents for customs declaration

pickupByShipzip
required
boolean

Should be set to true if this shipment will be picked up by Shipzip. Defaults to false

object (LocalCarrier)
referenceNumber
string or null

The unique id of the shipment in the sender system. ReferenceNumber will be written on the Proforma Label

object (Invoice)

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "receiver": {
    },
  • "description": "string",
  • "fromCountry": "AL",
  • "toCountry": "AL",
  • "serviceType": "AirExpress",
  • "carrierCode": "Usps",
  • "shipmentType": "Box",
  • "parcelInfo": {
    },
  • "customsDeclaration": "Courier",
  • "contents": [
    ],
  • "pickupByShipzip": false,
  • "localCarrier": {
    },
  • "referenceNumber": "string",
  • "invoice": {
    }
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Shipments

Update Shipment Info

Authorizations:
Bearer
Request Body schema:
shipmentId
required
string non-empty

Shipment reference id

required
object (Invoice)

Responses

Request samples

Content type
{
  • "shipmentId": "string",
  • "invoice": {
    }
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Shipments/{id}

Shows details of shipment object

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

/api/Shipments/Delete

Deletes shipment and cancels printed label. In order to use this method, the shipment must not have been received by Shipzip.

Authorizations:
Bearer
Request Body schema:
id
required
string non-empty
explanation
required
string [ 1 .. 1500 ] characters

Responses

Request samples

Content type
{
  • "id": "string",
  • "explanation": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

Tracking

Tracking related API operations

/api/Tracking/{id}

Returns all tracking actions for the given shipment Id

Authorizations:
Bearer
path Parameters
id
required
string
Example: S02000000152

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}

Rates

/api/Rates

Returns all possible rates for last mile delivery

Authorizations:
Bearer
Request Body schema:
weight
required
number <double>
required
object (ReceiverAddressInfo)

Receiver User address

Responses

Request samples

Content type
{
  • "weight": 0,
  • "receiverAddress": {
    }
}

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "statusCode": 0,
  • "isSuccess": true,
  • "error": {
    }
}