customerAddressCreate
Overview
Create a new customer address record. Provide the required fields via CreateCustomerAddressInput such as country, city, street, etc. The response returns the saved address.
- Type: GraphQL Mutation
- Endpoint: https://subdomain.com
- Authentication:
Authorization: Bearer <TOKEN>
Mutation
mutation CreateCustomerAddresses($input: CreateCustomerAddressInput!) {
createCustomerAddresses(input: $input) {
data {
_id
country {
_id
name
image { image imageUrl }
code
continent
capital
active
deleted
phonekey
createdAt
updatedAt
}
city {
_id
name
description
active
deleted
}
neighborhood
street
zipCode
description
account
device
deleted
}
message
success
}
}
Variables
{
"input": {
"countryId": "<COUNTRY_ID>",
"cityId": "<CITY_ID>",
"neighborhood": "District 5",
"street": "Main St",
"zipCode": "12345",
"description": "Primary home",
"device": "web"
}
}
Examples
- cURL
- JavaScript (fetch)
curl -X POST \
https://subdomain.com\
-H "Content-Type": "application/json" \
-H "Authorization: Bearer <TOKEN>" \
--data-binary @- << 'EOF'
{
"query": "mutation CreateCustomerAddresses($input: CreateCustomerAddressInput!) { createCustomerAddresses(input: $input) { success message data { _id neighborhood street } } }",
"variables": {
"input": {
"countryId": "<COUNTRY_ID>",
"cityId": "<CITY_ID>",
"street": "Main St",
"zipCode": "12345"
}
}
}
EOF
const res = await fetch('https://subdomain.com', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: 'Bearer ' + token,
},
body: JSON.stringify({
query: `
mutation CreateCustomerAddresses($input: CreateCustomerAddressInput!) {
createCustomerAddresses(input: $input) {
success
message
data { _id neighborhood street }
}
}
`,
variables: {
input: {
countryId: '<COUNTRY_ID>',
cityId: '<CITY_ID>',
street: 'Main St',
zipCode: '12345',
},
},
}),
});
const json = await res.json();
Notes
- Ensure the user/account has permission to add addresses; typically a valid token is required.
- Some implementations expect additional fields (phone, primary flag). Include them in
inputas needed.