Create

Create

Create

Adds a delivery range to an account.

Request

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

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
deliveryRange

Text
The label of the delivery range. Must not be empty and must be 32 characters or fewer.
active
Boolean
Indicates if the delivery range is active or inactive. Defaults to true if omitted.
{
  "deliveryRange": "0-10 miles",
  "active": true
}

Remarks

deliveryRange is required, cannot be empty, and cannot exceed 32 characters. If active is omitted, the delivery range is created as active.
Delivery range labels must be unique per account. Attempting to create a delivery range with a label that already exists for the account will fail with a 409 conflict.

Response

Headers

Location — the URL of the newly created delivery range.

Status Code

Code
Description
201 Created
The delivery range was created.
400 Bad Request
The delivery range was not created. This occurs if deliveryRange is missing, empty, or longer than 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 enabled, or the key does not have the required scope.
409 Conflict
A delivery range with that label already exists for this account.

Body

Name
Type
Description
uniqueId
Guid
The unique ID of the delivery range.
deliveryRange
Text
The label of the delivery range.
active
Boolean
Indicates if the delivery range is active or inactive.