71 lines
2.8 KiB
JSON
71 lines
2.8 KiB
JSON
{
|
|
"CustomerGroup": {
|
|
"filePath": "packages/modules/customer/src/models/customer-group.ts",
|
|
"properties": {
|
|
"id": "The ID of the customer group.",
|
|
"name": "The name of the customer group",
|
|
"metadata": "Holds custom data in key-value pairs.",
|
|
"created_by": "The ID of the user that created the customer group.",
|
|
"customers": "The associated customers.\n\n@expandable"
|
|
},
|
|
"deprecated": {
|
|
"is_deprecated": false
|
|
}
|
|
},
|
|
"CustomerGroupCustomer": {
|
|
"filePath": "packages/modules/customer/src/models/customer-group-customer.ts",
|
|
"properties": {
|
|
"id": "The ID of the group-customer pairing.",
|
|
"created_by": "The ID of the user that added the customer to the group.",
|
|
"metadata": "Holds custom data in key-value pairs.",
|
|
"customer": "The associated customer.\n\n@expandable",
|
|
"customer_group": "The associated customer group.\n\n@expandable"
|
|
},
|
|
"deprecated": {
|
|
"is_deprecated": false
|
|
}
|
|
},
|
|
"Customer": {
|
|
"filePath": "packages/modules/customer/src/models/customer.ts",
|
|
"properties": {
|
|
"id": "The ID of the customer.",
|
|
"company_name": "The company name of the customer",
|
|
"first_name": "The first name of the customer",
|
|
"last_name": "The last name of the customer",
|
|
"email": "The email of the customer",
|
|
"phone": "The phone of the customer",
|
|
"has_account": "Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)",
|
|
"metadata": "Holds custom data in key-value pairs.",
|
|
"created_by": "The ID of the user that created the customer.",
|
|
"groups": "The associated groups.\n\n@expandable",
|
|
"addresses": "The associated addresses.\n\n@expandable"
|
|
},
|
|
"deprecated": {
|
|
"is_deprecated": false
|
|
}
|
|
},
|
|
"CustomerAddress": {
|
|
"filePath": "packages/modules/customer/src/models/address.ts",
|
|
"properties": {
|
|
"id": "The ID of the customer address.",
|
|
"address_name": "The name of the customer address",
|
|
"is_default_shipping": "Whether the customer address is used by default for shipping.",
|
|
"is_default_billing": "Whether the customer address is used by default for billing.",
|
|
"company": "The company of the customer address",
|
|
"first_name": "The first name of the customer address",
|
|
"last_name": "The last name of the customer address",
|
|
"address_1": "The first line of the customer address",
|
|
"address_2": "The second line of the customer address",
|
|
"city": "The city of the customer address",
|
|
"country_code": "The country code of the customer address.\n\n@example us",
|
|
"province": "The province of the customer address",
|
|
"postal_code": "The postal code of the customer address",
|
|
"phone": "The phone of the customer address",
|
|
"metadata": "Holds custom data in key-value pairs.",
|
|
"customer": "The associated customer.\n\n@expandable"
|
|
},
|
|
"deprecated": {
|
|
"is_deprecated": false
|
|
}
|
|
}
|
|
} |