1. Warehouse
  2. Shipping Method

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, and code(if setup) for one or more Shipping Methods.

Example 1

Retrieve all Shipping Method's

Request URI

/shipping-method

Response

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

Example 2

Retrieve Shipping Method's 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
		},
		{
			"id": 2,
			"name": "Parcel Force",
			"code": "PRCLFRC",
			"breaks": "1000,2000,5000,1000",
			"methodType": 1,
			"additionalInformationRequired": false
		},
		{
			"id": 4,
			"name": "Other",
			"breaks": "1000,2000,5000,1000",
			"methodType": 1,
			"additionalInformationRequired": false
		}
	]
}