chore(docs): Generated API Reference (automated) (#9962)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
0fbee723b4
commit
242d00b567
@@ -0,0 +1,81 @@
|
||||
post:
|
||||
operationId: PostCustomersIdCustomerGroups
|
||||
summary: Add Customer Group to Customer
|
||||
description: Add a Customer Group to a customer
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The customer's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: fields
|
||||
in: query
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
properties:
|
||||
add:
|
||||
type: array
|
||||
description: The customer's add.
|
||||
items:
|
||||
type: string
|
||||
title: add
|
||||
description: The add's details.
|
||||
remove:
|
||||
type: array
|
||||
description: The customer's remove.
|
||||
items:
|
||||
type: string
|
||||
title: remove
|
||||
description: The remove's details.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_customers_{id}_customer-groups/post.sh
|
||||
tags:
|
||||
- Customers
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminCustomerResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: linkCustomerGroupsToCustomerWorkflow
|
||||
@@ -1217,12 +1217,16 @@ get:
|
||||
description: Filter by region IDs to retrieve their associated draft orders.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: Filter by region IDs to retrieve their associated draft orders.
|
||||
items:
|
||||
type: string
|
||||
title: region_id
|
||||
description: A region's ID.
|
||||
oneOf:
|
||||
- type: string
|
||||
title: region_id
|
||||
description: The draft order's region id.
|
||||
- type: array
|
||||
description: The draft order's region id.
|
||||
items:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The region id's details.
|
||||
- name: q
|
||||
in: query
|
||||
description: Search term to filter the order's searchable properties.
|
||||
@@ -1769,6 +1773,20 @@ get:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: customer_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: customer_id
|
||||
description: The draft order's customer id.
|
||||
- type: array
|
||||
description: The draft order's customer id.
|
||||
items:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The customer id's details.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -64,20 +64,6 @@ get:
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
- name: location_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: location_id
|
||||
description: Filter by an associated location's ID.
|
||||
- type: array
|
||||
description: Filter by associated location IDs.
|
||||
items:
|
||||
type: string
|
||||
title: location_id
|
||||
description: An associated location ID.
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
|
||||
@@ -171,12 +171,16 @@ get:
|
||||
description: Filter by region IDs to retrieve their associated orders.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: Filter by region IDs to retrieve their associated orders.
|
||||
items:
|
||||
type: string
|
||||
title: region_id
|
||||
description: A region ID.
|
||||
oneOf:
|
||||
- type: string
|
||||
title: region_id
|
||||
description: The order's region id.
|
||||
- type: array
|
||||
description: The order's region id.
|
||||
items:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The region id's details.
|
||||
- name: q
|
||||
in: query
|
||||
description: Search term to filter the order's searchable properties.
|
||||
@@ -723,6 +727,20 @@ get:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: customer_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: customer_id
|
||||
description: The order's customer id.
|
||||
- type: array
|
||||
description: The order's customer id.
|
||||
items:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The customer id's details.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
@@ -169,12 +169,16 @@ get:
|
||||
description: Filter by region IDs to retrieve their associated returns.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: Filter by region IDs to retrieve their associated returns.
|
||||
items:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The region id's details.
|
||||
oneOf:
|
||||
- type: string
|
||||
title: region_id
|
||||
description: The return's region id.
|
||||
- type: array
|
||||
description: The return's region id.
|
||||
items:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The region id's details.
|
||||
- name: q
|
||||
in: query
|
||||
description: Search term to filter the return's searchable properties.
|
||||
@@ -721,6 +725,20 @@ get:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: customer_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: customer_id
|
||||
description: The return's customer id.
|
||||
- type: array
|
||||
description: The return's customer id.
|
||||
items:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The customer id's details.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
|
||||
Reference in New Issue
Block a user