solved merge conflict
This commit is contained in:
--list
+1852
-1430
File diff suppressed because it is too large
Load Diff
+686
-624
File diff suppressed because it is too large
Load Diff
+479
-439
@@ -121,6 +121,369 @@ paths:
|
|||||||
properties:
|
properties:
|
||||||
exists:
|
exists:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
'/gift-cards/{code}':
|
||||||
|
get:
|
||||||
|
operationId: GetGiftCardsCode
|
||||||
|
summary: Retrieve Gift Card by Code
|
||||||
|
description: Retrieves a Gift Card by its associated unqiue code.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: code
|
||||||
|
required: true
|
||||||
|
description: The unique Gift Card code.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
tags:
|
||||||
|
- Gift Card
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
description: The id of the Gift Card
|
||||||
|
code:
|
||||||
|
description: The code of the Gift Card
|
||||||
|
value:
|
||||||
|
description: The original value of the Gift Card.
|
||||||
|
balance:
|
||||||
|
description: The current balanace of the Gift Card
|
||||||
|
region:
|
||||||
|
$ref: '#/components/schemas/region'
|
||||||
|
'/customers/{id}/addresses':
|
||||||
|
post:
|
||||||
|
operationId: PostCustomersCustomerAddresses
|
||||||
|
summary: Add a Shipping Address
|
||||||
|
description: Adds a Shipping Address to a Customer's saved addresses.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: The Customer id.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
address:
|
||||||
|
description: The Address to add to the Customer.
|
||||||
|
anyOf:
|
||||||
|
- $ref: '#/components/schemas/address'
|
||||||
|
tags:
|
||||||
|
- Customer
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: A successful response
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
customer:
|
||||||
|
$ref: '#/components/schemas/customer'
|
||||||
|
/customers:
|
||||||
|
post:
|
||||||
|
operationId: PostCustomers
|
||||||
|
summary: Create a Customer
|
||||||
|
description: Creates a Customer account.
|
||||||
|
parameters: []
|
||||||
|
tags:
|
||||||
|
- Customer
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
customer:
|
||||||
|
$ref: '#/components/schemas/customer'
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
required:
|
||||||
|
- email
|
||||||
|
- first_name
|
||||||
|
- last_name
|
||||||
|
- password
|
||||||
|
properties:
|
||||||
|
email:
|
||||||
|
type: string
|
||||||
|
description: The Customer's email address.
|
||||||
|
first_name:
|
||||||
|
type: string
|
||||||
|
description: The Customer's first name.
|
||||||
|
last_name:
|
||||||
|
type: string
|
||||||
|
description: The Customer's last name.
|
||||||
|
password:
|
||||||
|
type: string
|
||||||
|
description: The Customer's password for login.
|
||||||
|
phone:
|
||||||
|
type: string
|
||||||
|
description: The Customer's phone number.
|
||||||
|
'/customers/{id}/addresses/{address_id}':
|
||||||
|
delete:
|
||||||
|
operationId: DeleteCustomersCustomerAddressesAddress
|
||||||
|
summary: Delete an Address
|
||||||
|
description: Removes an Address from the Customer's saved addresse.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: The id of the Customer.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- in: path
|
||||||
|
name: address_id
|
||||||
|
required: true
|
||||||
|
description: The id of the Address to remove.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
tags:
|
||||||
|
- Customer
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
customer:
|
||||||
|
$ref: '#/components/schemas/customer'
|
||||||
|
post:
|
||||||
|
operationId: PostCustomersCustomerAddressesAddress
|
||||||
|
summary: Update a Shipping Address
|
||||||
|
description: Updates a Customer's saved Shipping Address.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: The Customer id.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- in: path
|
||||||
|
name: address_id
|
||||||
|
required: true
|
||||||
|
description: The id of the Address to update.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
address:
|
||||||
|
description: The updated Address.
|
||||||
|
anyOf:
|
||||||
|
- $ref: '#/components/schemas/address'
|
||||||
|
tags:
|
||||||
|
- Customer
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
customer:
|
||||||
|
$ref: '#/components/schemas/customer'
|
||||||
|
'/customers/{id}':
|
||||||
|
get:
|
||||||
|
operationId: GetCustomersCustomer
|
||||||
|
summary: Retrieves a Customer
|
||||||
|
description: >-
|
||||||
|
Retrieves a Customer - the Customer must be logged in to retrieve their
|
||||||
|
details.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: The id of the Customer.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
tags:
|
||||||
|
- Customer
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
customer:
|
||||||
|
$ref: '#/components/schemas/customer'
|
||||||
|
post:
|
||||||
|
operationId: PostCustomersCustomer
|
||||||
|
summary: Update Customer details
|
||||||
|
description: Updates a Customer's saved details.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: The id of the Customer.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
first_name:
|
||||||
|
description: The Customer's first name.
|
||||||
|
type: string
|
||||||
|
last_name:
|
||||||
|
description: The Customer's last name.
|
||||||
|
type: string
|
||||||
|
password:
|
||||||
|
description: The Customer's password.
|
||||||
|
type: string
|
||||||
|
phone:
|
||||||
|
description: The Customer's phone number.
|
||||||
|
type: string
|
||||||
|
tags:
|
||||||
|
- Customer
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
customer:
|
||||||
|
$ref: '#/components/schemas/customer'
|
||||||
|
'/customers/{id}/payment-methods':
|
||||||
|
get:
|
||||||
|
operationId: GetCustomersCustomerPaymentMethods
|
||||||
|
summary: Retrieve saved payment methods
|
||||||
|
description: >-
|
||||||
|
Retrieves a list of a Customer's saved payment methods. Payment methods
|
||||||
|
are saved with Payment Providers and it is their responsibility to fetch
|
||||||
|
saved methods.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: The id of the Customer.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
tags:
|
||||||
|
- Customer
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
payment_methods:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
properties:
|
||||||
|
provider_id:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
The id of the Payment Provider where the payment
|
||||||
|
method is saved.
|
||||||
|
data:
|
||||||
|
type: object
|
||||||
|
description: >-
|
||||||
|
The data needed for the Payment Provider to use the
|
||||||
|
saved payment method.
|
||||||
|
'/customers/{id}/orders':
|
||||||
|
get:
|
||||||
|
operationId: GetCustomersCustomerOrders
|
||||||
|
summary: Retrieve Customer Orders
|
||||||
|
description: Retrieves a list of a Customer's Orders.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: The id of the Customer.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
tags:
|
||||||
|
- Customer
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
payment_methods:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/order'
|
||||||
|
'/customers/{id}/password-token':
|
||||||
|
post:
|
||||||
|
operationId: PostCustomersCustomerPasswordToken
|
||||||
|
summary: Creates a reset password token
|
||||||
|
description: >-
|
||||||
|
Creates a reset password token to be used in a subsequent
|
||||||
|
/reset-password request. The password token should be sent out of band
|
||||||
|
e.g. via email and will not be returned.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: The id of the Customer.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
tags:
|
||||||
|
- Customer
|
||||||
|
responses:
|
||||||
|
'204':
|
||||||
|
description: OK
|
||||||
|
'/customers/{id}/reset-password':
|
||||||
|
post:
|
||||||
|
operationId: PostCustomersCustomerResetPassword
|
||||||
|
summary: Resets Customer password
|
||||||
|
description: >-
|
||||||
|
Resets a Customer's password using a password token created by a
|
||||||
|
previous /password-token request.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: The id of the Customer.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
tags:
|
||||||
|
- Customer
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
customer:
|
||||||
|
$ref: '#/components/schemas/customer'
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
required:
|
||||||
|
- email
|
||||||
|
- token
|
||||||
|
- password
|
||||||
|
properties:
|
||||||
|
email:
|
||||||
|
type: string
|
||||||
|
description: The Customer's email.
|
||||||
|
token:
|
||||||
|
type: string
|
||||||
|
description: The password token created by a /password-token request.
|
||||||
|
password:
|
||||||
|
type: string
|
||||||
|
description: The new password to set for the Customer.
|
||||||
'/carts/{id}/shipping-methods':
|
'/carts/{id}/shipping-methods':
|
||||||
post:
|
post:
|
||||||
operationId: PostCartsCartShippingMethod
|
operationId: PostCartsCartShippingMethod
|
||||||
@@ -654,369 +1017,6 @@ paths:
|
|||||||
data:
|
data:
|
||||||
type: object
|
type: object
|
||||||
description: The data to update the payment session with.
|
description: The data to update the payment session with.
|
||||||
'/customers/{id}/addresses':
|
|
||||||
post:
|
|
||||||
operationId: PostCustomersCustomerAddresses
|
|
||||||
summary: Add a Shipping Address
|
|
||||||
description: Adds a Shipping Address to a Customer's saved addresses.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: id
|
|
||||||
required: true
|
|
||||||
description: The Customer id.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
address:
|
|
||||||
description: The Address to add to the Customer.
|
|
||||||
anyOf:
|
|
||||||
- $ref: '#/components/schemas/address'
|
|
||||||
tags:
|
|
||||||
- Customer
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: A successful response
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
customer:
|
|
||||||
$ref: '#/components/schemas/customer'
|
|
||||||
/customers:
|
|
||||||
post:
|
|
||||||
operationId: PostCustomers
|
|
||||||
summary: Create a Customer
|
|
||||||
description: Creates a Customer account.
|
|
||||||
parameters: []
|
|
||||||
tags:
|
|
||||||
- Customer
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
customer:
|
|
||||||
$ref: '#/components/schemas/customer'
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
required:
|
|
||||||
- email
|
|
||||||
- first_name
|
|
||||||
- last_name
|
|
||||||
- password
|
|
||||||
properties:
|
|
||||||
email:
|
|
||||||
type: string
|
|
||||||
description: The Customer's email address.
|
|
||||||
first_name:
|
|
||||||
type: string
|
|
||||||
description: The Customer's first name.
|
|
||||||
last_name:
|
|
||||||
type: string
|
|
||||||
description: The Customer's last name.
|
|
||||||
password:
|
|
||||||
type: string
|
|
||||||
description: The Customer's password for login.
|
|
||||||
phone:
|
|
||||||
type: string
|
|
||||||
description: The Customer's phone number.
|
|
||||||
'/customers/{id}/addresses/{address_id}':
|
|
||||||
delete:
|
|
||||||
operationId: DeleteCustomersCustomerAddressesAddress
|
|
||||||
summary: Delete an Address
|
|
||||||
description: Removes an Address from the Customer's saved addresse.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: id
|
|
||||||
required: true
|
|
||||||
description: The id of the Customer.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- in: path
|
|
||||||
name: address_id
|
|
||||||
required: true
|
|
||||||
description: The id of the Address to remove.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
- Customer
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
customer:
|
|
||||||
$ref: '#/components/schemas/customer'
|
|
||||||
post:
|
|
||||||
operationId: PostCustomersCustomerAddressesAddress
|
|
||||||
summary: Update a Shipping Address
|
|
||||||
description: Updates a Customer's saved Shipping Address.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: id
|
|
||||||
required: true
|
|
||||||
description: The Customer id.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- in: path
|
|
||||||
name: address_id
|
|
||||||
required: true
|
|
||||||
description: The id of the Address to update.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
address:
|
|
||||||
description: The updated Address.
|
|
||||||
anyOf:
|
|
||||||
- $ref: '#/components/schemas/address'
|
|
||||||
tags:
|
|
||||||
- Customer
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
customer:
|
|
||||||
$ref: '#/components/schemas/customer'
|
|
||||||
'/customers/{id}':
|
|
||||||
get:
|
|
||||||
operationId: GetCustomersCustomer
|
|
||||||
summary: Retrieves a Customer
|
|
||||||
description: >-
|
|
||||||
Retrieves a Customer - the Customer must be logged in to retrieve their
|
|
||||||
details.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: id
|
|
||||||
required: true
|
|
||||||
description: The id of the Customer.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
- Customer
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
customer:
|
|
||||||
$ref: '#/components/schemas/customer'
|
|
||||||
post:
|
|
||||||
operationId: PostCustomersCustomer
|
|
||||||
summary: Update Customer details
|
|
||||||
description: Updates a Customer's saved details.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: id
|
|
||||||
required: true
|
|
||||||
description: The id of the Customer.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
first_name:
|
|
||||||
description: The Customer's first name.
|
|
||||||
type: string
|
|
||||||
last_name:
|
|
||||||
description: The Customer's last name.
|
|
||||||
type: string
|
|
||||||
password:
|
|
||||||
description: The Customer's password.
|
|
||||||
type: string
|
|
||||||
phone:
|
|
||||||
description: The Customer's phone number.
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
- Customer
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
customer:
|
|
||||||
$ref: '#/components/schemas/customer'
|
|
||||||
'/customers/{id}/payment-methods':
|
|
||||||
get:
|
|
||||||
operationId: GetCustomersCustomerPaymentMethods
|
|
||||||
summary: Retrieve saved payment methods
|
|
||||||
description: >-
|
|
||||||
Retrieves a list of a Customer's saved payment methods. Payment methods
|
|
||||||
are saved with Payment Providers and it is their responsibility to fetch
|
|
||||||
saved methods.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: id
|
|
||||||
required: true
|
|
||||||
description: The id of the Customer.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
- Customer
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
payment_methods:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
properties:
|
|
||||||
provider_id:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
The id of the Payment Provider where the payment
|
|
||||||
method is saved.
|
|
||||||
data:
|
|
||||||
type: object
|
|
||||||
description: >-
|
|
||||||
The data needed for the Payment Provider to use the
|
|
||||||
saved payment method.
|
|
||||||
'/customers/{id}/orders':
|
|
||||||
get:
|
|
||||||
operationId: GetCustomersCustomerOrders
|
|
||||||
summary: Retrieve Customer Orders
|
|
||||||
description: Retrieves a list of a Customer's Orders.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: id
|
|
||||||
required: true
|
|
||||||
description: The id of the Customer.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
- Customer
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
payment_methods:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/order'
|
|
||||||
'/customers/{id}/password-token':
|
|
||||||
post:
|
|
||||||
operationId: PostCustomersCustomerPasswordToken
|
|
||||||
summary: Creates a reset password token
|
|
||||||
description: >-
|
|
||||||
Creates a reset password token to be used in a subsequent
|
|
||||||
/reset-password request. The password token should be sent out of band
|
|
||||||
e.g. via email and will not be returned.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: id
|
|
||||||
required: true
|
|
||||||
description: The id of the Customer.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
- Customer
|
|
||||||
responses:
|
|
||||||
'204':
|
|
||||||
description: OK
|
|
||||||
'/customers/{id}/reset-password':
|
|
||||||
post:
|
|
||||||
operationId: PostCustomersCustomerResetPassword
|
|
||||||
summary: Resets Customer password
|
|
||||||
description: >-
|
|
||||||
Resets a Customer's password using a password token created by a
|
|
||||||
previous /password-token request.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: id
|
|
||||||
required: true
|
|
||||||
description: The id of the Customer.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
- Customer
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
customer:
|
|
||||||
$ref: '#/components/schemas/customer'
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
required:
|
|
||||||
- email
|
|
||||||
- token
|
|
||||||
- password
|
|
||||||
properties:
|
|
||||||
email:
|
|
||||||
type: string
|
|
||||||
description: The Customer's email.
|
|
||||||
token:
|
|
||||||
type: string
|
|
||||||
description: The password token created by a /password-token request.
|
|
||||||
password:
|
|
||||||
type: string
|
|
||||||
description: The new password to set for the Customer.
|
|
||||||
'/gift-cards/{code}':
|
|
||||||
get:
|
|
||||||
operationId: GetGiftCardsCode
|
|
||||||
summary: Retrieve Gift Card by Code
|
|
||||||
description: Retrieves a Gift Card by its associated unqiue code.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: code
|
|
||||||
required: true
|
|
||||||
description: The unique Gift Card code.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
- Gift Card
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
description: The id of the Gift Card
|
|
||||||
code:
|
|
||||||
description: The code of the Gift Card
|
|
||||||
value:
|
|
||||||
description: The original value of the Gift Card.
|
|
||||||
balance:
|
|
||||||
description: The current balanace of the Gift Card
|
|
||||||
region:
|
|
||||||
$ref: '#/components/schemas/region'
|
|
||||||
'/orders/cart/{cart_id}':
|
'/orders/cart/{cart_id}':
|
||||||
get:
|
get:
|
||||||
operationId: GetOrdersOrderCartId
|
operationId: GetOrdersOrderCartId
|
||||||
@@ -1097,56 +1097,6 @@ paths:
|
|||||||
properties:
|
properties:
|
||||||
order:
|
order:
|
||||||
$ref: '#/components/schemas/order'
|
$ref: '#/components/schemas/order'
|
||||||
'/products/{id}':
|
|
||||||
get:
|
|
||||||
operationId: GetProductsProduct
|
|
||||||
summary: Retrieves a Product
|
|
||||||
description: Retrieves a Product.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: id
|
|
||||||
required: true
|
|
||||||
description: The id of the Product.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
- Product
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
product:
|
|
||||||
$ref: '#/components/schemas/product'
|
|
||||||
/products:
|
|
||||||
get:
|
|
||||||
operationId: GetProducts
|
|
||||||
summary: List Products
|
|
||||||
description: Retrieves a list of Products.
|
|
||||||
tags:
|
|
||||||
- Product
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
count:
|
|
||||||
description: The total number of Products.
|
|
||||||
type: integer
|
|
||||||
offset:
|
|
||||||
description: The offset for pagination.
|
|
||||||
type: integer
|
|
||||||
limit:
|
|
||||||
description: 'The maxmimum number of Products to return,'
|
|
||||||
type: integer
|
|
||||||
products:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/product'
|
|
||||||
'/regions/{id}':
|
'/regions/{id}':
|
||||||
get:
|
get:
|
||||||
operationId: GetRegionsRegion
|
operationId: GetRegionsRegion
|
||||||
@@ -1197,6 +1147,56 @@ paths:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/region'
|
$ref: '#/components/schemas/region'
|
||||||
|
'/products/{id}':
|
||||||
|
get:
|
||||||
|
operationId: GetProductsProduct
|
||||||
|
summary: Retrieves a Product
|
||||||
|
description: Retrieves a Product.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
required: true
|
||||||
|
description: The id of the Product.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
tags:
|
||||||
|
- Product
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
product:
|
||||||
|
$ref: '#/components/schemas/product'
|
||||||
|
/products:
|
||||||
|
get:
|
||||||
|
operationId: GetProducts
|
||||||
|
summary: List Products
|
||||||
|
description: Retrieves a list of Products.
|
||||||
|
tags:
|
||||||
|
- Product
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
count:
|
||||||
|
description: The total number of Products.
|
||||||
|
type: integer
|
||||||
|
offset:
|
||||||
|
description: The offset for pagination.
|
||||||
|
type: integer
|
||||||
|
limit:
|
||||||
|
description: 'The maxmimum number of Products to return,'
|
||||||
|
type: integer
|
||||||
|
products:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/product'
|
||||||
'/return-reasons/{id}':
|
'/return-reasons/{id}':
|
||||||
get:
|
get:
|
||||||
operationId: GetReturnReasonsReason
|
operationId: GetReturnReasonsReason
|
||||||
@@ -1274,9 +1274,6 @@ paths:
|
|||||||
description: >-
|
description: >-
|
||||||
The id of the Shipping Option to create the Shipping
|
The id of the Shipping Option to create the Shipping
|
||||||
Method from.
|
Method from.
|
||||||
no_notification:
|
|
||||||
description: If set to true no notification will be send
|
|
||||||
type: boolean
|
|
||||||
tags:
|
tags:
|
||||||
- Return
|
- Return
|
||||||
responses:
|
responses:
|
||||||
@@ -1288,29 +1285,6 @@ paths:
|
|||||||
properties:
|
properties:
|
||||||
return:
|
return:
|
||||||
$ref: '#/components/schemas/return'
|
$ref: '#/components/schemas/return'
|
||||||
'/swaps/{cart_id}':
|
|
||||||
get:
|
|
||||||
operationId: GetSwapsSwapCartId
|
|
||||||
summary: Retrieve Swap by Cart id
|
|
||||||
description: Retrieves a Swap by the id of the Cart used to confirm the Swap.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: cart_id
|
|
||||||
required: true
|
|
||||||
description: The id of the Cart
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
- Swap
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
properties:
|
|
||||||
swap:
|
|
||||||
$ref: '#/components/schemas/swap'
|
|
||||||
/shipping-options:
|
/shipping-options:
|
||||||
get:
|
get:
|
||||||
operationId: GetShippingOptions
|
operationId: GetShippingOptions
|
||||||
@@ -1372,6 +1346,29 @@ paths:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/shipping_option'
|
$ref: '#/components/schemas/shipping_option'
|
||||||
|
'/swaps/{cart_id}':
|
||||||
|
get:
|
||||||
|
operationId: GetSwapsSwapCartId
|
||||||
|
summary: Retrieve Swap by Cart id
|
||||||
|
description: Retrieves a Swap by the id of the Cart used to confirm the Swap.
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: cart_id
|
||||||
|
required: true
|
||||||
|
description: The id of the Cart
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
tags:
|
||||||
|
- Swap
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
swap:
|
||||||
|
$ref: '#/components/schemas/swap'
|
||||||
'/variants/{variant_id}':
|
'/variants/{variant_id}':
|
||||||
get:
|
get:
|
||||||
operationId: GetVariantsVariant
|
operationId: GetVariantsVariant
|
||||||
@@ -1915,6 +1912,49 @@ components:
|
|||||||
metadata:
|
metadata:
|
||||||
description: An optional key-value map with additional information.
|
description: An optional key-value map with additional information.
|
||||||
type: object
|
type: object
|
||||||
|
draft-order:
|
||||||
|
title: DraftOrder
|
||||||
|
description: Represents a draft order
|
||||||
|
x-resourceId: draft-order
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
status:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- open
|
||||||
|
- completed
|
||||||
|
display_id:
|
||||||
|
type: string
|
||||||
|
cart_id:
|
||||||
|
type: string
|
||||||
|
cart:
|
||||||
|
anyOf:
|
||||||
|
- $ref: '#/components/schemas/cart'
|
||||||
|
order_id:
|
||||||
|
type: string
|
||||||
|
order:
|
||||||
|
anyOf:
|
||||||
|
- $ref: '#/components/schemas/order'
|
||||||
|
canceled_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
update_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
deleted_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
completed_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
idempotency_key:
|
||||||
|
type: string
|
||||||
fulfillment_item:
|
fulfillment_item:
|
||||||
title: Fulfillment Item
|
title: Fulfillment Item
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
import {MigrationInterface, QueryRunner} from "typeorm";
|
||||||
|
|
||||||
|
export class noNotification1622713782458 implements MigrationInterface {
|
||||||
|
|
||||||
|
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||||
|
}
|
||||||
|
|
||||||
|
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
@@ -226,6 +226,8 @@ export class ClaimOrder {
|
|||||||
* deleted_at:
|
* deleted_at:
|
||||||
* type: string
|
* type: string
|
||||||
* format: date-time
|
* format: date-time
|
||||||
|
* no_notification:
|
||||||
|
* type: boolean
|
||||||
* metadata:
|
* metadata:
|
||||||
* type: object
|
* type: object
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -417,4 +417,6 @@ export class Order {
|
|||||||
* type: integer
|
* type: integer
|
||||||
* paid_total:
|
* paid_total:
|
||||||
* type: integer
|
* type: integer
|
||||||
|
* no_notification:
|
||||||
|
* type: boolean
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -168,6 +168,9 @@ export class Return {
|
|||||||
* description: "The date with timezone at which the resource was last updated."
|
* description: "The date with timezone at which the resource was last updated."
|
||||||
* type: string
|
* type: string
|
||||||
* format: date-time
|
* format: date-time
|
||||||
|
* no_notification:
|
||||||
|
* description: "When set to true, no notification will be sent related to this return."
|
||||||
|
* type: boolean
|
||||||
* metadata:
|
* metadata:
|
||||||
* description: "An optional key-value map with additional information."
|
* description: "An optional key-value map with additional information."
|
||||||
* type: object
|
* type: object
|
||||||
|
|||||||
@@ -227,6 +227,9 @@ export class Swap {
|
|||||||
* description: "The date with timezone at which the resource was last updated."
|
* description: "The date with timezone at which the resource was last updated."
|
||||||
* type: string
|
* type: string
|
||||||
* format: date-time
|
* format: date-time
|
||||||
|
* no_notification:
|
||||||
|
* description: "If set to true, no notification will be sent related to this swap"
|
||||||
|
* type: boolean
|
||||||
* metadata:
|
* metadata:
|
||||||
* description: "An optional key-value map with additional information."
|
* description: "An optional key-value map with additional information."
|
||||||
* type: object
|
* type: object
|
||||||
|
|||||||
Reference in New Issue
Block a user