Mappings

Add address to address group

post

Add an address to an existing address group by mapping it to the specified group ID

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

groupIdnumberRequiredPattern: [^\/#\?]+?

Body

application/json

addressIdnumberOptional

Id of the address

Example: 1

addressGroupIdnumberOptional

Id of the address group

Example: 1

Responses

200Success

application/json

post

/api/addresses/groups/{groupId}/mappings

HTTPcURLJavaScriptPython

POST /api/addresses/groups/{groupId}/mappings HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "addressId": 1,
  "addressGroupId": 1,
  "address": {}
}

200Success

{
  "id": 12,
  "addressGroupId": 12,
  "addressId": 34,
  "address": {},
  "addressGroup": {},
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z"
}

Update address mapping in an address group

put

Update an address mapping in an address group using the provided IDs and data

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

groupIdnumberRequiredPattern: [^\/#\?]+?

addressGroupMappingIdnumberRequiredPattern: [^\/#\?]+?

Body

application/json

addressIdnumberOptional

Id of the address

Example: 1

addressGroupIdnumberOptional

Id of the address group

Example: 1

Responses

200Success

application/json

put

/api/addresses/groups/{groupId}/mappings/{addressGroupMappingId}

HTTPcURLJavaScriptPython

PUT /api/addresses/groups/{groupId}/mappings/{addressGroupMappingId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "addressId": 1,
  "addressGroupId": 1,
  "address": {}
}

200Success

{
  "id": 12,
  "addressGroupId": 12,
  "addressId": 34,
  "address": {},
  "addressGroup": {},
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z"
}

Remove address mapping from address group

delete

Remove an address mapping from an address group by using the group ID and mapping ID

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

groupIdnumberRequiredPattern: [^\/#\?]+?

addressGroupMappingIdnumberRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

delete

/api/addresses/groups/{groupId}/mappings/{addressGroupMappingId}

HTTPcURLJavaScriptPython

DELETE /api/addresses/groups/{groupId}/mappings/{addressGroupMappingId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 12,
  "addressGroupId": 12,
  "addressId": 34,
  "address": {},
  "addressGroup": {},
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z"
}