Skip to main content

checkoutAssociateUser Mutation

Description​

Associates a user account with a checkout.

mutation checkoutAssociateUser($id: String!, $data: JSON) {
checkoutAssociateUser(id: $id, data: $data) {
_id
id
configRef
origin
created
shipping {
status
date
method
freeShippingThreshold
tracking
shopCollection
weight
}
billing {
status
paymentDate
refundDate
}
orderId
note {
date
content
}
items {
_id
id
quantity
added
total
unavailable
}
buyer {
_id
email
firstName
id
lastName
name
telephone
organisation
taxNumber
isGuest
}
seller {
_id
id
firstName
lastName
name
email
telephone
taxNumber
}
updated
expires
status
message
totals {
grand
leftToPay
discount
itemsQuantity
itemQuantity
subtotal
subtotalBeforeTaxes
shipping
tax
}
urls {
checkout
storefront
}
useSingleAddress
}
}

Variables​

{
"id": "Qts-I1HeH",
"data": {}
}

Response​

{
"checkoutAssociateUser": {
"_id": "caba13e49dfdfbb28d29b417",
"id": "xCs-9esVn",
"configRef": "2d155bdf8efbf922ca6146b1",
"origin": "example",
"created": 1765668413107,
"shipping": {
"status": "example",
"date": 1771816502279,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": "example"
},
"billing": {
"status": "example",
"paymentDate": 1787288583365,
"refundDate": 1765730319732
},
"orderId": "example",
"note": {
"date": 1770741517975,
"content": "example"
},
"items": [
{
"_id": "481c6dc71978b6bf29037fa2",
"id": "2FH-Sv2bV",
"quantity": 1.23,
"added": 1744819607438,
"total": 29.99,
"unavailable": true
}
],
"buyer": {
"_id": "554aac8f5e7b19626e9ee58e",
"email": "email@example.com",
"firstName": "example",
"id": 1.23,
"lastName": "example",
"name": "example",
"telephone": "example",
"organisation": "example",
"taxNumber": "example",
"isGuest": true
},
"seller": {
"_id": "2a61ef0499924c60b38f7f7e",
"id": "ETp-XptiL",
"firstName": "example",
"lastName": "example",
"name": "example",
"email": "email@example.com",
"telephone": "example",
"taxNumber": "example"
},
"updated": 1747180962687,
"expires": 1745814416465,
"status": "example",
"message": "example",
"totals": {
"grand": 1.23,
"leftToPay": 1.23,
"discount": 0.1,
"itemsQuantity": 1.23,
"itemQuantity": 42,
"subtotal": 1.23,
"subtotalBeforeTaxes": 1.23,
"shipping": 1.23,
"tax": 1.23
},
"urls": {
"checkout": "example",
"storefront": "example"
},
"useSingleAddress": true
}
}

Arguments​

NameTypeDescription
idString!Checkout identifier string.
dataJSONAdditional user data in JSON format.

Returns​

Checkout