Create

Create

Create

Adds a shipping method to an account.

Request

Method
URL
POST
 https://api.solatech-dos.com/lists/v1/accounts/{accountUniqueId}/shippingmethods 

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.

Headers

Name
Required
Type
Description
APIKey

Guid
A valid API key with a scope of AccountLists

Body

Name
Required
Type
Description
shippingMethod

Text
The name of the shipping method. Maximum length is 32 characters and it cannot be empty.
active
Boolean
Indicates if the shipping method is active or inactive. The default is active.
{
  "shippingMethod": "UPS Ground",
  "active": true
}

Remarks

shippingMethod is required, cannot be empty, and cannot exceed 32 characters.
A shipping method's name must be unique within an account. If a shipping method with the same name already exists for the account, the request will fail with a 409 Conflict.
If active is omitted, the shipping method is created as active.

Response

Headers

Location — the URL of the newly created shipping method.

Status Code

Code
Description
201 Created
The shipping method was created.
400 Bad Request
The shipping method was not created. This occurs if shippingMethod is missing, empty, or exceeds 32 characters.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
403 Forbidden
The API key does not belong to this account, the account does not have the API-keys feature, or the key does not have the required scope.
409 Conflict
A shipping method with that name already exists for this account.

Body

Name
Type
Description
uniqueId
Guid
The unique ID of the shipping method.
shippingMethod
Text
The name of the shipping method.
active
Boolean
Indicates if the shipping method is active or inactive.