diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 7362cdd31..4b7073dec 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -49,6 +49,7 @@ paths: operationId: CustomersGet deprecated: false parameters: + - $ref: '#/components/parameters/Accept' - name: page in: query description: Page number. `page=1` @@ -232,6 +233,9 @@ paths: - Customers operationId: CustomersPost deprecated: false + parameters: + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' requestBody: content: application/json: @@ -239,6 +243,10 @@ paths: type: array items: $ref: '#/components/schemas/customer_Post' + required: + - email + - first_name + - last_name examples: example-1: value: @@ -320,6 +328,9 @@ paths: summary: Update Customers tags: - Customers + parameters: + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' operationId: CustomersPut deprecated: false responses: @@ -341,6 +352,8 @@ paths: type: array items: $ref: '#/components/schemas/customer_Put' + required: + - id examples: example-1: value: @@ -400,6 +413,7 @@ paths: type: array items: type: integer + - $ref: '#/components/parameters/Accept' responses: '204': description: '' @@ -411,16 +425,7 @@ paths: operationId: CustomersAddressesGet deprecated: false parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' - name: page in: query description: Page number. `page=1` @@ -516,16 +521,8 @@ paths: operationId: CustomersAddressesPost deprecated: false parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' requestBody: content: application/json: @@ -533,6 +530,13 @@ paths: type: array items: $ref: '#/components/schemas/address_Post' + required: + - customer_id + - first_name + - last_name + - city + - country_code + - address1 examples: example-1: value: @@ -607,16 +611,8 @@ paths: operationId: CustomersAddressesPut deprecated: false parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' requestBody: content: application/json: @@ -624,6 +620,8 @@ paths: type: array items: $ref: '#/components/schemas/address_Put' + required: + - id examples: example-1: value: @@ -683,16 +681,7 @@ paths: operationId: CustomersAddressesDelete deprecated: false parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' - in: query name: 'id:in' required: true @@ -717,6 +706,9 @@ paths: - Customer Validate Credentials description: Validate a customer credentials - This endpoint has special rate limiting protections to protect against abuse. summary: Validate a customer credentials + parameters: + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' operationId: CustomerValidateCredentials requestBody: required: true @@ -767,6 +759,8 @@ paths: tags: - Customer Settings description: Returns the global-level customer settings. + parameters: + - $ref: '#/components/parameters/Accept' summary: Get Customer Settings operationId: CustomerSettingsGet responses: @@ -791,6 +785,9 @@ paths: description: Updates the customer settings on the global level. summary: Update Customer Settings operationId: CustomerSettingsPut + parameters: + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' requestBody: content: application/json: @@ -841,6 +838,7 @@ paths: schema: type: integer required: true + - $ref: '#/components/parameters/Accept' responses: '200': description: Customer settings for this channel are returned. @@ -878,6 +876,8 @@ paths: schema: type: integer required: true + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' requestBody: content: application/json: @@ -912,12 +912,6 @@ paths: guest_customer_group_id: 0 default_customer_group_id: 0 allow_global_logins: true - parameters: - - schema: - type: string - name: channel_id - in: path - required: true '/customers/attributes': get: description: Returns a list of Customer Attributes. You can pass in optional filter parameters. @@ -995,16 +989,8 @@ paths: schema: type: string format: date-time - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' responses: '200': $ref: '#/components/responses/CustomerAttributesResponse' @@ -1032,16 +1018,8 @@ paths: operationId: CustomersAttributesPost deprecated: false parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' requestBody: content: application/json: @@ -1049,6 +1027,9 @@ paths: type: array items: $ref: '#/components/schemas/attribute_Post' + required: + - name + - type required: true x-examples: application/json: @@ -1081,16 +1062,8 @@ paths: operationId: CustomersAttributesPut deprecated: false parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' requestBody: content: application/json: @@ -1098,6 +1071,8 @@ paths: type: array items: $ref: '#/components/schemas/attribute_Put' + required: + - id required: true x-examples: application/json: @@ -1136,16 +1111,7 @@ paths: items: type: integer format: int32 - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' responses: '204': description: '' @@ -1159,16 +1125,7 @@ paths: operationId: CustomersAttributeValuesGet deprecated: false parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' - name: page in: query description: Page number. `page=1` @@ -1253,16 +1210,8 @@ paths: operationId: CustomersAttributeValuesPut deprecated: false parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' requestBody: content: application/json: @@ -1331,16 +1280,7 @@ paths: items: type: integer format: int32 - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' responses: '204': description: '' @@ -1367,16 +1307,7 @@ paths: tags: - Customer Form Field Values parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - - name: Content-Type - in: header - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' - name: page in: query description: Page number. `page=1` @@ -1448,6 +1379,9 @@ paths: operationId: CustomerFormFieldValuePUT tags: - Customer Form Field Values + parameters: + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' requestBody: content: application/json: @@ -1504,13 +1438,9 @@ paths: operationId: CustomersConsentByCustomerId_PUT deprecated: false parameters: - - name: Content-Type - in: header - required: false - description: '' - schema: - type: string - default: application/json + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/customerId' requestBody: content: application/json: @@ -1554,6 +1484,7 @@ paths: operationId: liststoredinstruments parameters: + - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/customerId' responses: '200': @@ -1615,12 +1546,6 @@ paths: example: code: 403 message: Missing scope - parameters: - - schema: - type: string - name: customerId - in: path - required: true components: parameters: customerId: @@ -1630,6 +1555,20 @@ components: description: '' schema: type: string + Content-Type: + name: Content-Type + in: header + required: false + description: '' + schema: + type: string + default: application/json + Accept: + name: Accept + in: header + schema: + type: string + default: application/json responses: CustomerCollectionResponse: description: Customer Collection Response @@ -1775,16 +1714,6 @@ components: allOf: - $ref: "#/components/schemas/formFieldValue_Address" title: 'Customer Address Form Field Value' - required: - - address1 - - city - - country_code - - customer_id - - first_name - - id - - last_name - - postal_code - - state_or_province meta: $ref: '#/components/schemas/_metaCollection' examples: @@ -2028,6 +1957,10 @@ components: title: CustomerAttributeValueCollectionResponse description: Response payload for the BigCommerce API. type: object + required: + - attribute_id + - attribute_value + - customer_id properties: data: type: array @@ -2063,10 +1996,6 @@ components: description: The date of which the customer attribute value was created. type: string format: date-time - required: - - attribute_id - - attribute_value - - customer_id meta: title: Collection Meta description: 'Data about the response, including pagination and collection totals.' @@ -2122,6 +2051,10 @@ components: properties: data: type: array + required: + - name + - type + - id items: title: Customer Attribute type: object @@ -2152,10 +2085,6 @@ components: description: The date of which the customer attribute was created. type: string format: date-time - required: - - name - - type - - id meta: $ref: '#/components/schemas/MetaOpen' examples: @@ -2678,8 +2607,8 @@ components: email: description: The email of the customer. Must be unique. type: string - minLength: 3 - maxLength: 255 + minLength: 7 + maxLength: 250 first_name: description: The first name of the customer. type: string @@ -2746,14 +2675,12 @@ components: Array of form fields. Controlled by formfields parameter. items: $ref: "#/components/schemas/formFieldValue" - required: - - email - - first_name - - last_name x-internal: false customer_Put: title: customer_Put type: object + required: + - id properties: email: description: The email of the customer. Must be unique. @@ -2822,12 +2749,14 @@ components: Array of form fields. Controlled by formfields parameter. items: $ref: "#/components/schemas/formFieldValue" - required: - - id x-internal: false attributeValue_Base: title: attributeValue_Base type: object + required: + - attribute_id + - value + - customer_id properties: id: description: Attribute value ID. @@ -2851,10 +2780,7 @@ components: description: Customer ID. format: int32 example: 8504 - required: - - attribute_id - - value - - customer_id + x-internal: false attribute_Full: description: '' @@ -2902,6 +2828,9 @@ components: attribute_Put: title: attribute_Put type: object + required: + - name + - id properties: name: description: Attribute name. @@ -2912,9 +2841,6 @@ components: description: Attribute ID. type: integer format: int32 - required: - - name - - id description: 'Once the data type is set, it can not be changed. The attribute will need to be deleted then created again with the new data type. This will also delete it from the customer.' x-internal: false attribute_Post: @@ -2923,6 +2849,9 @@ components: name: attribute_string 01 type: string type: object + required: + - name + - type properties: name: description: Attribute name. @@ -2938,13 +2867,20 @@ components: - string - number - date - required: - - name - - type x-internal: false address_Full: title: address_Full type: object + required: + - first_name + - last_name + - address1 + - city + - state_or_province + - postal_code + - country_code + - customer_id + - id properties: first_name: description: The first name of the customer address. @@ -3018,20 +2954,12 @@ components: allOf: - $ref: "#/components/schemas/formFieldValue" title: 'Customer Address Form Field Value' - required: - - first_name - - last_name - - address1 - - city - - state_or_province - - postal_code - - country_code - - customer_id - - id x-internal: false address_Put: title: address_Put type: object + required: + - id properties: first_name: description: The first name of the customer address. @@ -3100,8 +3028,6 @@ components: Array of form fields. Controlled by formfields parameter. items: $ref: "#/components/schemas/formFieldValue" - required: - - id x-examples: example-1: value: @@ -3111,6 +3037,13 @@ components: address_Post: title: address_Post type: object + required: + - first_name + - last_name + - address1 + - city + - country_code + - customer_id properties: first_name: type: string @@ -3187,13 +3120,6 @@ components: The address custom form field values items: $ref: "#/components/schemas/formFieldValue" - required: - - first_name - - last_name - - address1 - - city - - country_code - - customer_id x-examples: Example: value: @@ -3225,6 +3151,12 @@ components: postal_code: '33333' state_or_province: California type: object + required: + - first_name + - last_name + - address1 + - city + - country_code properties: first_name: description: The first name of the customer address. @@ -3280,12 +3212,6 @@ components: enum: - residential - commercial - required: - - first_name - - last_name - - address1 - - city - - country_code description: The `address` object for the `customer` object's `addresses` array. x-internal: false customerAddresses_CustomerPost: @@ -3306,6 +3232,12 @@ components: - name: "test" value: "test" type: object + required: + - first_name + - last_name + - address1 + - city + - country_code properties: first_name: description: The first name associated with the customer address. @@ -3368,12 +3300,6 @@ components: allOf: - $ref: "#/components/schemas/formFieldValue" title: 'Customer Address Form Field Value' - required: - - first_name - - last_name - - address1 - - city - - country_code description: The `address` object for the `customer` object's `addresses` array. x-internal: false customerAuthentication_PostPut: