added changes to swap and notification service
This commit is contained in:
--list
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -976,6 +976,55 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
@@ -1481,277 +1530,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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}": {
|
||||
"get": {
|
||||
"operationId": "GetReturnReasonsReason",
|
||||
"summary": "Retrieve a Return Reason",
|
||||
"description": "Retrieves a Return Reason.",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "id",
|
||||
"required": true,
|
||||
"description": "The id of the Return Reason.",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
"Return Reason"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"properties": {
|
||||
"return_reason": {
|
||||
"$ref": "#/components/schemas/return_reason"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/return-reasons": {
|
||||
"get": {
|
||||
"operationId": "GetReturnReasons",
|
||||
"summary": "List Return Reasons",
|
||||
"description": "Retrieves a list of Return Reasons.",
|
||||
"tags": [
|
||||
"Return Reason"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"properties": {
|
||||
"return_reasons": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/return_reason"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/regions/{id}": {
|
||||
"get": {
|
||||
"operationId": "GetRegionsRegion",
|
||||
"summary": "Retrieves a Region",
|
||||
"description": "Retrieves a Region.",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "id",
|
||||
"required": true,
|
||||
"description": "The id of the Region.",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
"Region"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"properties": {
|
||||
"region": {
|
||||
"$ref": "#/components/schemas/region"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/regions": {
|
||||
"get": {
|
||||
"operationId": "GetRegions",
|
||||
"summary": "List Regions",
|
||||
"description": "Retrieves a list of Regions.",
|
||||
"tags": [
|
||||
"Region"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"properties": {
|
||||
"count": {
|
||||
"description": "The total number of regions.",
|
||||
"type": "integer"
|
||||
},
|
||||
"offset": {
|
||||
"description": "The offset for pagination.",
|
||||
"type": "integer"
|
||||
},
|
||||
"limit": {
|
||||
"description": "The maxmimum number of regions to return,",
|
||||
"type": "integer"
|
||||
},
|
||||
"regions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/region"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/orders/cart/{cart_id}": {
|
||||
"get": {
|
||||
"operationId": "GetOrdersOrderCartId",
|
||||
@@ -1872,6 +1650,162 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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}": {
|
||||
"get": {
|
||||
"operationId": "GetRegionsRegion",
|
||||
"summary": "Retrieves a Region",
|
||||
"description": "Retrieves a Region.",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "id",
|
||||
"required": true,
|
||||
"description": "The id of the Region.",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
"Region"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"properties": {
|
||||
"region": {
|
||||
"$ref": "#/components/schemas/region"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/regions": {
|
||||
"get": {
|
||||
"operationId": "GetRegions",
|
||||
"summary": "List Regions",
|
||||
"description": "Retrieves a list of Regions.",
|
||||
"tags": [
|
||||
"Region"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"properties": {
|
||||
"count": {
|
||||
"description": "The total number of regions.",
|
||||
"type": "integer"
|
||||
},
|
||||
"offset": {
|
||||
"description": "The offset for pagination.",
|
||||
"type": "integer"
|
||||
},
|
||||
"limit": {
|
||||
"description": "The maxmimum number of regions to return,",
|
||||
"type": "integer"
|
||||
},
|
||||
"regions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/region"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/returns": {
|
||||
"post": {
|
||||
"operationId": "PostReturns",
|
||||
@@ -1911,6 +1845,10 @@
|
||||
"description": "The id of the Shipping Option to create the Shipping Method from."
|
||||
}
|
||||
}
|
||||
},
|
||||
"no_notification": {
|
||||
"description": "If set to true no notification will be send",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1938,6 +1876,72 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/return-reasons/{id}": {
|
||||
"get": {
|
||||
"operationId": "GetReturnReasonsReason",
|
||||
"summary": "Retrieve a Return Reason",
|
||||
"description": "Retrieves a Return Reason.",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "id",
|
||||
"required": true,
|
||||
"description": "The id of the Return Reason.",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
"Return Reason"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"properties": {
|
||||
"return_reason": {
|
||||
"$ref": "#/components/schemas/return_reason"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/return-reasons": {
|
||||
"get": {
|
||||
"operationId": "GetReturnReasons",
|
||||
"summary": "List Return Reasons",
|
||||
"description": "Retrieves a list of Return Reasons.",
|
||||
"tags": [
|
||||
"Return Reason"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"properties": {
|
||||
"return_reasons": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/return_reason"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/shipping-options": {
|
||||
"get": {
|
||||
"operationId": "GetShippingOptions",
|
||||
@@ -2696,10 +2700,6 @@
|
||||
"$ref": "#/components/schemas/product"
|
||||
}
|
||||
},
|
||||
"usage_limit": {
|
||||
"description": "The maximum number of times that a discount can be used.",
|
||||
"type": "integer"
|
||||
},
|
||||
"created_at": {
|
||||
"description": "The date with timezone at which the resource was created.",
|
||||
"type": "string",
|
||||
@@ -2771,6 +2771,14 @@
|
||||
"$ref": "#/components/schemas/region"
|
||||
}
|
||||
},
|
||||
"usage_limit": {
|
||||
"description": "The maximum number of times that a discount can be used.",
|
||||
"type": "integer"
|
||||
},
|
||||
"usage_count": {
|
||||
"description": "The number of times a discount has been used.",
|
||||
"type": "integer"
|
||||
},
|
||||
"created_at": {
|
||||
"description": "The date with timezone at which the resource was created.",
|
||||
"type": "string",
|
||||
@@ -3545,6 +3553,9 @@
|
||||
},
|
||||
"gift_card_total": {
|
||||
"type": "integer"
|
||||
},
|
||||
"paid_total": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -1147,47 +1147,6 @@ paths:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/product'
|
||||
'/return-reasons/{id}':
|
||||
get:
|
||||
operationId: GetReturnReasonsReason
|
||||
summary: Retrieve a Return Reason
|
||||
description: Retrieves a Return Reason.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The id of the Return Reason.
|
||||
schema:
|
||||
type: string
|
||||
tags:
|
||||
- Return Reason
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
return_reason:
|
||||
$ref: '#/components/schemas/return_reason'
|
||||
/return-reasons:
|
||||
get:
|
||||
operationId: GetReturnReasons
|
||||
summary: List Return Reasons
|
||||
description: Retrieves a list of Return Reasons.
|
||||
tags:
|
||||
- Return Reason
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
return_reasons:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/return_reason'
|
||||
'/regions/{id}':
|
||||
get:
|
||||
operationId: GetRegionsRegion
|
||||
@@ -1238,6 +1197,47 @@ paths:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/region'
|
||||
'/return-reasons/{id}':
|
||||
get:
|
||||
operationId: GetReturnReasonsReason
|
||||
summary: Retrieve a Return Reason
|
||||
description: Retrieves a Return Reason.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The id of the Return Reason.
|
||||
schema:
|
||||
type: string
|
||||
tags:
|
||||
- Return Reason
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
return_reason:
|
||||
$ref: '#/components/schemas/return_reason'
|
||||
/return-reasons:
|
||||
get:
|
||||
operationId: GetReturnReasons
|
||||
summary: List Return Reasons
|
||||
description: Retrieves a list of Return Reasons.
|
||||
tags:
|
||||
- Return Reason
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
return_reasons:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/return_reason'
|
||||
/returns:
|
||||
post:
|
||||
operationId: PostReturns
|
||||
@@ -1274,6 +1274,9 @@ paths:
|
||||
description: >-
|
||||
The id of the Shipping Option to create the Shipping
|
||||
Method from.
|
||||
no_notification:
|
||||
description: If set to true no notification will be send
|
||||
type: boolean
|
||||
tags:
|
||||
- Return
|
||||
responses:
|
||||
@@ -1285,6 +1288,29 @@ paths:
|
||||
properties:
|
||||
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:
|
||||
get:
|
||||
operationId: GetShippingOptions
|
||||
@@ -1346,29 +1372,6 @@ paths:
|
||||
type: array
|
||||
items:
|
||||
$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}':
|
||||
get:
|
||||
operationId: GetVariantsVariant
|
||||
@@ -1829,9 +1832,6 @@ components:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/product'
|
||||
usage_limit:
|
||||
description: The maximum number of times that a discount can be used.
|
||||
type: integer
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
@@ -1894,6 +1894,12 @@ components:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/region'
|
||||
usage_limit:
|
||||
description: The maximum number of times that a discount can be used.
|
||||
type: integer
|
||||
usage_count:
|
||||
description: The number of times a discount has been used.
|
||||
type: integer
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
@@ -2527,6 +2533,8 @@ components:
|
||||
type: integer
|
||||
gift_card_total:
|
||||
type: integer
|
||||
paid_total:
|
||||
type: integer
|
||||
payment_provider:
|
||||
title: Payment Provider
|
||||
description: Represents a Payment Provider plugin and holds its installation status.
|
||||
|
||||
Reference in New Issue
Block a user