List address assignments

Request

Security

OAuth2(Required scopes: FullAccessAddressAdminAddressReader)

Path

buyerIDstringrequired

ID of the buyer.

Query

addressIDstring

ID of the address.

userIDstring

ID of the user.

userGroupIDstring

ID of the user group.

levelstring(PartyType)

Level of the address assignment. Possible values: User, Group, Company, BuyerGroup.

Enum:"User""Group""Company""BuyerGroup"

isShippingboolean

Is shipping of the address assignment.

isBillingboolean

Is billing of the address assignment.

pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

pageSizeinteger

Number of results to return per page.

curl -i -X GET \
  'https://api.ordercloud.io/v1/buyers/{buyerID}/addresses/assignments?addressID=string&userID=string&userGroupID=string&level=User&isShipping=true&isBilling=true&page=0&pageSize=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

ItemsArray of objects(AddressAssignment)

Example:

[
  {
    "AddressID": "",
    "UserID": "",
    "UserGroupID": "",
    "IsShipping": false,
    "IsBilling": false
  }
]

Metaobject(Meta)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}