Shipping Method GET

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/shipping-method/{ID-SET}

Refer to our documentation on URI syntax for more information on how to construct URIs.

Description

Returns the ID, name, code (if set up), price breaks, price break method, additional information requirement, carrier name (if set up), and country list for one or more Shipping Methods.

Example 1

Retrieve all Shipping Methods

Request URI

/shipping-method

Response

{
	"response": [
		{
			"id": 1,
			"name": "APC",
			"breaks": "1000,2000,5000,1000",
			"methodType": 1,
			"additionalInformationRequired": false,
			"countries": ""
		},
		{
			"id": 2,
			"name": "Parcel Force",
			"code": "PRCLFRC",
			"breaks": "1000,2000,5000,1000",
			"methodType": 1,
			"additionalInformationRequired": false,
			"carrier": "Parcel Force",
			"countries": "UK",
			"channelBrandTemplates": {
				1: 12,
				2: 11
			}
		},
		{
			"id": 4,
			"name": "Other",
			"breaks": "1000,2000,5000,1000",
			"methodType": 1,
			"additionalInformationRequired": false,
			"countries": "",
			"channelBrandTemplates": {
			}
		},
		{
			"id": 5,
			"name": "Target Express",
			"code": "TRGREXPR1",
			"breaks": "1000,2000,5000,1000",
			"methodType": 1,
			"additionalInformationRequired": true,
			"countries": "UK,US",
			"channelBrandTemplates": {
			}
		}
	]
}

Example 2

Retrieve Shipping Methods with ID in range 1 to 4.

Request URI

/shipping-method/1-4

Response

{
	"response": [
		{
			"id": 1,
			"name": "APC",
			"breaks": "1000,2000,5000,1000",
			"methodType": 1,
			"additionalInformationRequired": false,
			"countries": "",
			"channelBrandTemplates": {
			}
		},
		{
			"id": 2,
			"name": "Parcel Force",
			"code": "PRCLFRC",
			"breaks": "1000,2000,5000,1000",
			"methodType": 1,
			"additionalInformationRequired": false,
			"carrier": "Parcel Force",
			"countries": "UK",
			"channelBrandTemplates": {
			}
		},
		{
			"id": 4,
			"name": "Other",
			"breaks": "1000,2000,5000,1000",
			"methodType": 1,
			"additionalInformationRequired": false,
			"countries": "",
			"channelBrandTemplates": {
			}
		}
	]
}