Version 2 of the Schenker AB (Sweden) Partner services API. Four operations: DeliveryPoint/v2 GetServicePoint (by four-digit service point number), GetAllServicePoints and GetNearestServicePoint, plus TrackAndTraceAdvanced/v2/GetParcel which resolves a parcel and its event history from a country code, reference type and reference. Read-only polling; no webhook or subscription operation is published. Swagger 2.0, HTTP Basic authentication.
{
"swagger": "2.0",
"info": {
"version": "V2",
"title": "Partner services API V2.",
"description": "<a target=\"_blank\" href=\"/Utils/PartnerServices/ParcelServicesExamples.zip\">This zip</a> includes example/sample code to connect to DB Schenker Partner API.",
"x-swagger-net-version": "8.5.28.001"
},
"host": "parcelservices-se.dbschenker.com",
"basePath": "/Apipartner",
"schemes": [
"https"
],
"paths": {
"/DeliveryPoint/v2/GetServicePoint": {
"get": {
"tags": [
"DeliveryPoint2"
],
"summary": "Get Servicepoints based on servicepoint number.",
"operationId": "DeliveryPoint2_GetServicePoint",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Countycode for specified country.",
"required": true,
"type": "string"
},
{
"name": "servicePointNumber",
"in": "query",
"description": "Four digit servicepoint number.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Service Point found",
"schema": {
"$ref": "#/definitions/ServicePointDTO"
}
},
"204": {
"description": "No service point found"
},
"400": {
"description": "Invalid request"
},
"401": {
"description": "Unauthorized"
}
},
"deprecated": false,
"security": [
{
"basic": []
}
]
}
},
"/DeliveryPoint/v2/GetAllServicePoints": {
"get": {
"tags": [
"DeliveryPoint2"
],
"summary": "Get all Existing Servicepoints for a specified country.",
"operationId": "DeliveryPoint2_GetAllServicePoints",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Countycode for specified country",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Service Points found",
"schema": {
"items": {
"$ref": "#/definitions/ServicePointDTO"
},
"xml": {
"name": "ServicePointDTO",
"wrapped": true
},
"type": "array"
}
},
"204": {
"description": "No service point found"
},
"400": {
"description": "Invalid request"
},
"401": {
"description": "Unauthorized"
}
},
"deprecated": true,
"security": [
{
"basic": []
}
]
}
},
"/DeliveryPoint/v2/GetNearestServicePoint": {
"post": {
"tags": [
"DeliveryPoint2"
],
"summary": "Gives you a list of the ServicePoints nearest to the specified location.",
"operationId": "DeliveryPoint2_GetNearestServicePoint",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "searchModel",
"in": "body",
"description": "The data structure for the search",
"required": true,
"schema": {
"$ref": "#/definitions/SearchModel"
}
}
],
"responses": {
"200": {
"description": "Service Points found",
"schema": {
"items": {
"$ref": "#/definitions/ServicePointDTO"
},
"xml": {
"name": "ServicePointDTO",
"wrapped": true
},
"type": "array"
}
},
"204": {
"description": "No service point found"
},
"400": {
"description": "Invalid request"
},
"401": {
"description": "Unauthorized"
}
},
"deprecated": true,
"security": [
{
"basic": []
}
]
}
},
"/TrackAndTraceAdvanced/v2/GetParcel": {
"get": {
"tags": [
"TrackAndTraceAdvanced2"
],
"summary": "Retrieves a parcel from a reference",
"operationId": "TrackAndTraceAdvanced2_GetParcel",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "The country code",
"required": true,
"type": "string"
},
{
"name": "referenceType",
"in": "query",
"description": "A parcel's referenceType",
"required": true,
"type": "string"
},
{
"name": "reference",
"in": "query",
"description": "A parcel's reference",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"401": {
"description": "Unauthorized"
}
},
"deprecated": false,
"security": [
{
"basic": []
}
]
}
}
},
"definitions": {
"ServicePointDTO": {
"required": [
"Name",
"Addresses",
"GeoPoint",
"OpeningDays",
"Services",
"References"
],
"properties": {
"Name": {
"type": "string"
},
"DeliveryType": {
"type": "string"
},
"Addresses": {
"items": {
"$ref": "#/definitions/AddressDTO"
},
"xml": {
"name": "AddressDTO",
"wrapped": true
},
"type": "array"
},
"GeoPoint": {
"$ref": "#/definitions/GeoPointDTO"
},
"OpeningHoursShort": {
"type": "string"
},
"OpeningHoursRow1": {
"type": "string"
},
"OpeningHoursRow2": {
"type": "string"
},
"OpeningHoursRow3": {
"type": "string"
},
"OpeningDays": {
"items": {
"$ref": "#/definitions/WeekdayDTO"
},
"xml": {
"name": "WeekdayDTO",
"wrapped": true
},
"type": "array"
},
"Services": {
"items": {
"$ref": "#/definitions/ServiceDTO"
},
"xml": {
"name": "ServiceDTO",
"wrapped": true
},
"type": "array"
},
"References": {
"items": {
"$ref": "#/definitions/ReferenceDTO"
},
"xml": {
"name": "ReferenceDTO",
"wrapped": true
},
"type": "array"
},
"DeliveryData": {
"items": {
"$ref": "#/definitions/DeliveryDataDTO"
},
"xml": {
"name": "DeliveryDataDTO",
"wrapped": true
},
"type": "array"
},
"Distance": {
"type": "string"
},
"ProviderAddon": {
"type": "string"
}
},
"xml": {
"name": "ServicePointDTO"
},
"type": "object"
},
"AddressDTO": {
"required": [
"AddressType"
],
"properties": {
"AddressType": {
"type": "string"
},
"AddressId": {
"type": "string"
},
"MailingAddress": {
"$ref": "#/definitions/MailingAddressDTO"
},
"Contacts": {
"items": {
"$ref": "#/definitions/ContactDTO"
},
"xml": {
"name": "ContactDTO",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "AddressDTO"
},
"type": "object"
},
"GeoPointDTO": {
"required": [
"Latitude",
"Longitude"
],
"properties": {
"Latitude": {
"type": "string"
},
"Longitude": {
"type": "string"
}
},
"xml": {
"name": "GeoPointDTO"
},
"type": "object"
},
"WeekdayDTO": {
"required": [
"Day",
"DisplayName",
"OpeningHours"
],
"properties": {
"Day": {
"type": "string"
},
"DisplayName": {
"type": "string"
},
"OpeningHours": {
"items": {
"$ref": "#/definitions/OpenDTO"
},
"xml": {
"name": "OpenDTO",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "WeekdayDTO"
},
"type": "object"
},
"ServiceDTO": {
"required": [
"ServiceType"
],
"properties": {
"ServiceType": {
"type": "string"
},
"DisplayName": {
"type": "string"
}
},
"xml": {
"name": "ServiceDTO"
},
"type": "object"
},
"ReferenceDTO": {
"required": [
"ReferenceType",
"Value"
],
"properties": {
"ReferenceType": {
"type": "string"
},
"Value": {
"type": "string"
}
},
"xml": {
"name": "ReferenceDTO"
},
"type": "object"
},
"DeliveryDataDTO": {
"properties": {
"DataType": {
"type": "string"
},
"Value": {
"type": "string"
}
},
"xml": {
"name": "DeliveryDataDTO"
},
"type": "object"
},
"MailingAddressDTO": {
"required": [
"Name",
"AddressLine1",
"City",
"PostalCode"
],
"properties": {
"Name": {
"type": "string"
},
"CoAddress": {
"type": "string"
},
"AddressLine1": {
"type": "string"
},
"AddressLine2": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"CountryCode": {
"type": "string",
"maxLength": 3,
"minLength": 2
}
},
"xml": {
"name": "MailingAddressDTO"
},
"type": "object"
},
"ContactDTO": {
"required": [
"ContactType",
"Value"
],
"properties": {
"ContactType": {
"type": "string"
},
"Value": {
"type": "string"
}
},
"xml": {
"name": "ContactDTO"
},
"type": "object"
},
"OpenDTO": {
"required": [
"From",
"To"
],
"properties": {
"From": {
"type": "string"
},
"To": {
"type": "string"
}
},
"xml": {
"name": "OpenDTO"
},
"type": "object"
},
"SearchModel": {
"required": [
"CountryCode"
],
"properties": {
"CountryCode": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"StreetAddress": {
"type": "string"
},
"City": {
"type": "string"
},
"Amount": {
"type": "integer",
"format": "int32"
}
},
"xml": {
"name": "SearchModel"
},
"type": "object"
}
},
"securityDefinitions": {
"basic": {
"type": "basic",
"description": "Basic HTTP Authentication"
}
},
"tags": [
{
"name": "DeliveryPoint2",
"description": "Responsible for all Web API functions related to Service Points"
},
{
"name": "TrackAndTraceAdvanced2",
"description": "Responsible for all Web API functions related to Advanced Track and Trace."
}
]
}