GLS.API (Version 1.0)
API change historyCreateShopReturn
Try itRequest
Request URL
Request parameters
-
(optional)string
The requested API version
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
{
"username": "string",
"password": "string",
"shippingSystemName": "string",
"shippingSystemVersion": "string",
"shiptype": "p",
"customerNo": "string",
"customerSubjectName": "string",
"reference": "string",
"trackingLinkType": "u",
"units": [
{
"unitId": "string",
"unitType": "co",
"customerUnitReference": "string",
"weight": 0.0,
"additionalInfo1": "string",
"additionalInfo2": "string"
}
],
"labelType": "zpl",
"labelA4StartPosition": 0,
"labelA4MoveXMm": 0,
"labelA4MoveYMm": 0,
"addresses": {
"pickupAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string"
},
"deliveryAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string",
"addresseeType": "b"
},
"requesterAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string"
}
},
"returnReason": "string",
"sendLabelsByEmail": true
}{
"required": [
"password",
"username"
],
"type": "object",
"properties": {
"username": {
"maxLength": 70,
"minLength": 1,
"type": "string"
},
"password": {
"maxLength": 20,
"minLength": 1,
"type": "string",
"writeOnly": true
},
"shippingSystemName": {
"type": "string",
"nullable": true
},
"shippingSystemVersion": {
"type": "string",
"nullable": true
},
"shiptype": {
"enum": [
"p",
"f"
],
"type": "string"
},
"customerNo": {
"maxLength": 8,
"minLength": 7,
"type": "string",
"nullable": true
},
"customerSubjectName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"reference": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"trackingLinkType": {
"enum": [
"u",
"s"
],
"type": "string"
},
"units": {
"type": "array",
"items": {
"required": [
"unitId",
"weight"
],
"type": "object",
"properties": {
"unitId": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"unitType": {
"enum": [
"co",
"lg",
"mp",
"bp",
"xl",
"pl",
"rl"
],
"type": "string"
},
"customerUnitReference": {
"maxLength": 35,
"type": "string",
"nullable": true
},
"weight": {
"type": "number",
"format": "float"
},
"additionalInfo1": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"additionalInfo2": {
"maxLength": 30,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"nullable": true
},
"labelType": {
"enum": [
"zpl",
"zplUtf8",
"zpl300",
"zpl300Utf8",
"pdf",
"pdfRoutingOnly",
"zplRoutingOnly",
"zplUtf8RoutingOnly",
"zpl300RoutingOnly",
"zpl300Utf8RoutingOnly",
"pdfA6U",
"pdfA6S",
"pdf2A4",
"pdf4A4",
"none"
],
"type": "string"
},
"labelA4StartPosition": {
"type": "integer",
"format": "int32",
"nullable": true
},
"labelA4MoveXMm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"labelA4MoveYMm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"addresses": {
"type": "object",
"properties": {
"pickupAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"deliveryAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
},
"addresseeType": {
"enum": [
"b",
"p"
],
"type": "string"
}
},
"additionalProperties": false
},
"requesterAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"returnReason": {
"type": "string",
"nullable": true
},
"sendLabelsByEmail": {
"type": "boolean"
}
},
"additionalProperties": false
}{
"username": "string",
"password": "string",
"shippingSystemName": "string",
"shippingSystemVersion": "string",
"shiptype": "p",
"customerNo": "string",
"customerSubjectName": "string",
"reference": "string",
"trackingLinkType": "u",
"units": [
{
"unitId": "string",
"unitType": "co",
"customerUnitReference": "string",
"weight": 0.0,
"additionalInfo1": "string",
"additionalInfo2": "string"
}
],
"labelType": "zpl",
"labelA4StartPosition": 0,
"labelA4MoveXMm": 0,
"labelA4MoveYMm": 0,
"addresses": {
"pickupAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string"
},
"deliveryAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string",
"addresseeType": "b"
},
"requesterAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string"
}
},
"returnReason": "string",
"sendLabelsByEmail": true
}{
"required": [
"password",
"username"
],
"type": "object",
"properties": {
"username": {
"maxLength": 70,
"minLength": 1,
"type": "string"
},
"password": {
"maxLength": 20,
"minLength": 1,
"type": "string",
"writeOnly": true
},
"shippingSystemName": {
"type": "string",
"nullable": true
},
"shippingSystemVersion": {
"type": "string",
"nullable": true
},
"shiptype": {
"enum": [
"p",
"f"
],
"type": "string"
},
"customerNo": {
"maxLength": 8,
"minLength": 7,
"type": "string",
"nullable": true
},
"customerSubjectName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"reference": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"trackingLinkType": {
"enum": [
"u",
"s"
],
"type": "string"
},
"units": {
"type": "array",
"items": {
"required": [
"unitId",
"weight"
],
"type": "object",
"properties": {
"unitId": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"unitType": {
"enum": [
"co",
"lg",
"mp",
"bp",
"xl",
"pl",
"rl"
],
"type": "string"
},
"customerUnitReference": {
"maxLength": 35,
"type": "string",
"nullable": true
},
"weight": {
"type": "number",
"format": "float"
},
"additionalInfo1": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"additionalInfo2": {
"maxLength": 30,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"nullable": true
},
"labelType": {
"enum": [
"zpl",
"zplUtf8",
"zpl300",
"zpl300Utf8",
"pdf",
"pdfRoutingOnly",
"zplRoutingOnly",
"zplUtf8RoutingOnly",
"zpl300RoutingOnly",
"zpl300Utf8RoutingOnly",
"pdfA6U",
"pdfA6S",
"pdf2A4",
"pdf4A4",
"none"
],
"type": "string"
},
"labelA4StartPosition": {
"type": "integer",
"format": "int32",
"nullable": true
},
"labelA4MoveXMm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"labelA4MoveYMm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"addresses": {
"type": "object",
"properties": {
"pickupAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"deliveryAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
},
"addresseeType": {
"enum": [
"b",
"p"
],
"type": "string"
}
},
"additionalProperties": false
},
"requesterAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"returnReason": {
"type": "string",
"nullable": true
},
"sendLabelsByEmail": {
"type": "boolean"
}
},
"additionalProperties": false
}{
"username": "string",
"password": "string",
"shippingSystemName": "string",
"shippingSystemVersion": "string",
"shiptype": "p",
"customerNo": "string",
"customerSubjectName": "string",
"reference": "string",
"trackingLinkType": "u",
"units": [
{
"unitId": "string",
"unitType": "co",
"customerUnitReference": "string",
"weight": 0.0,
"additionalInfo1": "string",
"additionalInfo2": "string"
}
],
"labelType": "zpl",
"labelA4StartPosition": 0,
"labelA4MoveXMm": 0,
"labelA4MoveYMm": 0,
"addresses": {
"pickupAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string"
},
"deliveryAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string",
"addresseeType": "b"
},
"requesterAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string"
}
},
"returnReason": "string",
"sendLabelsByEmail": true
}{
"required": [
"password",
"username"
],
"type": "object",
"properties": {
"username": {
"maxLength": 70,
"minLength": 1,
"type": "string"
},
"password": {
"maxLength": 20,
"minLength": 1,
"type": "string",
"writeOnly": true
},
"shippingSystemName": {
"type": "string",
"nullable": true
},
"shippingSystemVersion": {
"type": "string",
"nullable": true
},
"shiptype": {
"enum": [
"p",
"f"
],
"type": "string"
},
"customerNo": {
"maxLength": 8,
"minLength": 7,
"type": "string",
"nullable": true
},
"customerSubjectName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"reference": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"trackingLinkType": {
"enum": [
"u",
"s"
],
"type": "string"
},
"units": {
"type": "array",
"items": {
"required": [
"unitId",
"weight"
],
"type": "object",
"properties": {
"unitId": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"unitType": {
"enum": [
"co",
"lg",
"mp",
"bp",
"xl",
"pl",
"rl"
],
"type": "string"
},
"customerUnitReference": {
"maxLength": 35,
"type": "string",
"nullable": true
},
"weight": {
"type": "number",
"format": "float"
},
"additionalInfo1": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"additionalInfo2": {
"maxLength": 30,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"nullable": true
},
"labelType": {
"enum": [
"zpl",
"zplUtf8",
"zpl300",
"zpl300Utf8",
"pdf",
"pdfRoutingOnly",
"zplRoutingOnly",
"zplUtf8RoutingOnly",
"zpl300RoutingOnly",
"zpl300Utf8RoutingOnly",
"pdfA6U",
"pdfA6S",
"pdf2A4",
"pdf4A4",
"none"
],
"type": "string"
},
"labelA4StartPosition": {
"type": "integer",
"format": "int32",
"nullable": true
},
"labelA4MoveXMm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"labelA4MoveYMm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"addresses": {
"type": "object",
"properties": {
"pickupAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"deliveryAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
},
"addresseeType": {
"enum": [
"b",
"p"
],
"type": "string"
}
},
"additionalProperties": false
},
"requesterAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"returnReason": {
"type": "string",
"nullable": true
},
"sendLabelsByEmail": {
"type": "boolean"
}
},
"additionalProperties": false
}{
"username": "string",
"password": "string",
"shippingSystemName": "string",
"shippingSystemVersion": "string",
"shiptype": "p",
"customerNo": "string",
"customerSubjectName": "string",
"reference": "string",
"trackingLinkType": "u",
"units": [
{
"unitId": "string",
"unitType": "co",
"customerUnitReference": "string",
"weight": 0.0,
"additionalInfo1": "string",
"additionalInfo2": "string"
}
],
"labelType": "zpl",
"labelA4StartPosition": 0,
"labelA4MoveXMm": 0,
"labelA4MoveYMm": 0,
"addresses": {
"pickupAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string"
},
"deliveryAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string",
"addresseeType": "b"
},
"requesterAddress": {
"name1": "string",
"name2": "string",
"name3": "string",
"street": "string",
"houseNo": "string",
"houseNoExt": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"contact": "string",
"phone": "string",
"email": "string"
}
},
"returnReason": "string",
"sendLabelsByEmail": true
}{
"required": [
"password",
"username"
],
"type": "object",
"properties": {
"username": {
"maxLength": 70,
"minLength": 1,
"type": "string"
},
"password": {
"maxLength": 20,
"minLength": 1,
"type": "string",
"writeOnly": true
},
"shippingSystemName": {
"type": "string",
"nullable": true
},
"shippingSystemVersion": {
"type": "string",
"nullable": true
},
"shiptype": {
"enum": [
"p",
"f"
],
"type": "string"
},
"customerNo": {
"maxLength": 8,
"minLength": 7,
"type": "string",
"nullable": true
},
"customerSubjectName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"reference": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"trackingLinkType": {
"enum": [
"u",
"s"
],
"type": "string"
},
"units": {
"type": "array",
"items": {
"required": [
"unitId",
"weight"
],
"type": "object",
"properties": {
"unitId": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"unitType": {
"enum": [
"co",
"lg",
"mp",
"bp",
"xl",
"pl",
"rl"
],
"type": "string"
},
"customerUnitReference": {
"maxLength": 35,
"type": "string",
"nullable": true
},
"weight": {
"type": "number",
"format": "float"
},
"additionalInfo1": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"additionalInfo2": {
"maxLength": 30,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"nullable": true
},
"labelType": {
"enum": [
"zpl",
"zplUtf8",
"zpl300",
"zpl300Utf8",
"pdf",
"pdfRoutingOnly",
"zplRoutingOnly",
"zplUtf8RoutingOnly",
"zpl300RoutingOnly",
"zpl300Utf8RoutingOnly",
"pdfA6U",
"pdfA6S",
"pdf2A4",
"pdf4A4",
"none"
],
"type": "string"
},
"labelA4StartPosition": {
"type": "integer",
"format": "int32",
"nullable": true
},
"labelA4MoveXMm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"labelA4MoveYMm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"addresses": {
"type": "object",
"properties": {
"pickupAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"deliveryAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
},
"addresseeType": {
"enum": [
"b",
"p"
],
"type": "string"
}
},
"additionalProperties": false
},
"requesterAddress": {
"required": [
"city",
"countryCode",
"name1",
"street",
"zipCode"
],
"type": "object",
"properties": {
"name1": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"name2": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"name3": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"street": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"houseNo": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"houseNoExt": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"zipCode": {
"maxLength": 8,
"minLength": 1,
"type": "string"
},
"city": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"countryCode": {
"maxLength": 2,
"minLength": 1,
"type": "string"
},
"contact": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"email": {
"maxLength": 320,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"returnReason": {
"type": "string",
"nullable": true
},
"sendLabelsByEmail": {
"type": "boolean"
}
},
"additionalProperties": false
}Responses
200 OK
Success
Representations
{
"error": true,
"status": "string",
"message": "string",
"errors": {},
"transactionId": "string",
"shipmentTrackingLink": "string",
"labels": "string",
"units": [
{}
]
}{
"type": "object",
"properties": {
"error": {
"type": "boolean",
"readOnly": true
},
"status": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
},
"transactionId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"shipmentTrackingLink": {
"type": "string",
"nullable": true
},
"labels": {
"type": "string",
"nullable": true
},
"units": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"nullable": true
}
},
"additionalProperties": false
}400 Bad Request
Bad Request
Representations
{
"error": true,
"status": "string",
"message": "string",
"errors": {},
"transactionId": "string"
}{
"type": "object",
"properties": {
"error": {
"type": "boolean",
"readOnly": true
},
"status": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
},
"transactionId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
}401 Unauthorized
Unauthorized
Representations
{
"error": true,
"status": "string",
"message": "string",
"errors": {},
"transactionId": "string"
}{
"type": "object",
"properties": {
"error": {
"type": "boolean",
"readOnly": true
},
"status": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
},
"transactionId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
}422 Unprocessable Entity
Client Error
Representations
{
"error": true,
"status": "string",
"message": "string",
"errors": {},
"transactionId": "string"
}{
"type": "object",
"properties": {
"error": {
"type": "boolean",
"readOnly": true
},
"status": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
},
"transactionId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
}424 Failed Dependency
Client Error
Representations
{
"error": true,
"status": "string",
"message": "string",
"errors": {},
"transactionId": "string"
}{
"type": "object",
"properties": {
"error": {
"type": "boolean",
"readOnly": true
},
"status": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
},
"transactionId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
}Code samples
@ECHO OFF
curl -v -X POST "https://api.gls.nl/Test/V1/api/ShopReturn/Create?api-version=1.0"
-H "Content-Type: application/json-patch+json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["api-version"] = "1.0";
var uri = "https://api.gls.nl/Test/V1/api/ShopReturn/Create?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.gls.nl/Test/V1/api/ShopReturn/Create");
builder.setParameter("api-version", "1.0");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json-patch+json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"api-version": "1.0",
};
$.ajax({
url: "https://api.gls.nl/Test/V1/api/ShopReturn/Create?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.gls.nl/Test/V1/api/ShopReturn/Create";
NSArray* array = @[
// Request parameters
@"entities=true",
@"api-version=1.0",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.gls.nl/Test/V1/api/ShopReturn/Create');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json-patch+json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'api-version' => '1.0',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'api-version': '1.0',
})
try:
conn = httplib.HTTPSConnection('api.gls.nl')
conn.request("POST", "/Test/V1/api/ShopReturn/Create?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'api-version': '1.0',
})
try:
conn = http.client.HTTPSConnection('api.gls.nl')
conn.request("POST", "/Test/V1/api/ShopReturn/Create?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.gls.nl/Test/V1/api/ShopReturn/Create')
query = URI.encode_www_form({
# Request parameters
'api-version' => '1.0'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body