Skip to content
snapcasterDevelopers

OrderWebhookCustomer

Reusable OrderWebhookCustomer schema.

Type: object

Fields

FieldTypeConstraintsMeaningExample
namerequiredstringNoneThe human-readable name of the resource.string (generated)
emailrequiredstringNoneThe contact email for the person represented by this record.string (generated)
shipping_addressrequiredobjectNoneThe delivery address snapshot frozen for the Order.{ "line1": "string", "line2": "string", "city": "string", "province": "string", "postal_code": "string", "country": "string" } (generated)
shipping_address.line1requiredstringNoneThe primary street-address line.string (generated)
shipping_address.line2requiredstring or nullNoneThe optional unit, suite, or secondary address line.string (generated)
shipping_address.cityrequiredstringNoneThe municipality in the delivery address.string (generated)
shipping_address.provincerequiredstringNoneThe Canadian province or territory in the delivery address.string (generated)
shipping_address.postal_coderequiredstringNoneThe Canadian postal code in the delivery address.string (generated)
shipping_address.countryrequiredstringNoneISO 3166-1 alpha-2 country code.string (generated)

Examples

Generated Schema example: Generated OrderWebhookCustomer
{
"name": "string",
"email": "string",
"shipping_address": {
"line1": "string",
"line2": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"country": "string"
}
}

Source commit: 64bff06fe339e6ffa0ef24cd7da55cb3efefefb9