1. Warehouse
  2. Shipping Method

Shipping Method POST

URI

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

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

Description

This message allows you to create a new Shipping Method.

Detailed field description:
Field Name Field Description Required Maximum Length
name This is the name of the Shipping Method. This must be unique. Yes 128
code The shipping method code. No 128
additionalInformationRequired Boolean value which controls whether additional information (e.g. weight or boxes) should be supplied when using this shipping method. No
methodType This describes how the price breaks are determined. Options are:
  1. weight
  2. price
  3. number of items
 No
breaks A comma separated list of the upper boundary values of the price breaks. No 256
carrier The name of the carrier that provides this shipping method. No 64
countries A comma separated list of country codes. No 255
channelBrandTemplates A mapping of channel brand IDs to the associated packing note template ID. If none is given for a particular channel brand then that brand's default template is used. No

Things to be aware of:

    The following need not be specified in the POST body but are part of the shipping-method resource. They have the following default values:

    • Breaks will default to 10,100,250,1000,100000
    • Ship method warehouse will default to 2 (Main warehouse)
    • Ship method requires reference will default to false
    • Ship method type will default to 1 (Weight)
    • Carrier name will default to a null value

Example 1

Create a new shipping method specifying all details and using price break option 3 (number of items)

Request URI

/shipping-method/

Request body

{
	"name": "Item shipping method",
	"breaks": "1,5,15,1000",
	"methodType": 3,
	"additionalInformationRequired": false,
	"countries": "UK,US",
	"carrier": "Parcel Force",
	"channelBrandTemplates": {
		1: 11,
		2: 12
	}
}

Response

{
	"response": 1
}

Example 2

Create a new shipping method specifying name only

Request URI

/shipping-method/

Request body

{
	"name": "Parcel delivery shipping method"
}

Response

{
	"response": 1
}