Update

Update

Update

Updates an existing shipping method on an account.

Request

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

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.
itemUniqueId

Guid
The unique ID of the shipping method.

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. If supplied, it is subject to the same validation as create (maximum 32 characters, cannot be empty). If omitted, the currently stored name is left unchanged.
active
Boolean
Indicates if the shipping method is active or inactive. If omitted, the currently stored value is left unchanged.
{
  "active": false
}

Remarks

All fields are optional on update. Omitting a field entirely leaves that field's currently stored value unchanged — it is not reset to a default. In the example above, only active is supplied, so the shipping method's name is left exactly as it was before the update.
If a field is supplied, it is validated the same way it is on Create. Supplying an empty shippingMethod value is different from omitting it and will fail validation, since shippingMethod cannot be empty.
A shipping method's name must remain unique within an account. If shippingMethod is supplied and it matches the name of another shipping method on the same account, the request will fail with a 409 Conflict.

Response

Headers

None

Status Code

Code
Description
200 OK
The shipping method was updated. The updated shipping method is returned.
400 Bad Request
The shipping method was not updated. This occurs if shippingMethod is supplied but is 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.
404 Not Found
No shipping method was found with that id for this account.
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.