PRproject44
Capacity Provider Account Group Management

Create a new capacity provider account group.

The capacity provider account group requires a unique code and may use an optional name. The response will include a unique id that can be used to reference the capacity provider account group in other APIs.

<br/><h4><b>Required Fields</h4></b>

<ul><li> name </li><li> code </li></ul>
post/api/v4/capacityprovideraccountgroups

Request

Request body

codestring

The unique, user-provided code used to identify this account group. Typically, an account group will correspond to a single customer or a single customer location. Account group codes are provided in shipment lifecycle APIs to identify a particular account. This field may be provided when creating an account group but is not required when creating or updating a set of capacity provider accounts in the capacity provider account management API.

idinteger

The project44-generated id of the capacity provider account group. This id may not be provided when creating a capacity provider account group, but it is required when updating one or when creating or updating a capacity provider account set.

namestring

The user-provided name to be assigned to this group. This field may be provided when creating an account group but is not required when creating or updating a set of capacity provider accounts in the capacity provider account management API.

Response

Created

codestring

The unique, user-provided code used to identify this account group. Typically, an account group will correspond to a single customer or a single customer location. Account group codes are provided in shipment lifecycle APIs to identify a particular account. This field may be provided when creating an account group but is not required when creating or updating a set of capacity provider accounts in the capacity provider account management API.

idinteger

The project44-generated id of the capacity provider account group. This id may not be provided when creating a capacity provider account group, but it is required when updating one or when creating or updating a capacity provider account set.

namestring

The user-provided name to be assigned to this group. This field may be provided when creating an account group but is not required when creating or updating a set of capacity provider accounts in the capacity provider account management API.

Changes

No recorded changes to this operation across all 1 revision of this API.