asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: fixture improvements + small fixes (#204)

Browse Source 
* fix: deref arrays

* docs: clean up

* fix: update license
This commit is contained in:
Sebastian Rindom
2021-03-16 18:15:41 +01:00
committed by GitHub
parent 34bb39afa3
commit 3d0dff58c4
23 changed files with 2079 additions and 1599 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1019
docs/api/admin-spec3.json
View File

File diff suppressed because it is too large Load Diff

132
docs/api/admin-spec3.yaml
View File

@@ -53,7 +53,7 @@ paths:
application/json:
schema:
properties:
customer:
user:
$ref: '#/components/schemas/user'
requestBody:
content:
@@ -83,7 +83,7 @@ paths:
application/json:
schema:
properties:
customer:
user:
$ref: '#/components/schemas/user'
/collections:
post:
@@ -695,6 +695,49 @@ paths:
properties:
discount:
$ref: '#/components/schemas/discount'
/notifications:
get:
operationId: GetNotifications
summary: List Notifications
description: Retrieves a list of Notifications.
tags:
- Notification
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
notifications:
type: array
items:
$ref: '#/components/schemas/notification'
'/notifications/{id}/resend':
post:
operationId: PostNotificationsNotificationResend
summary: Resend Notification
description: >-
Resends a previously sent notifications, with the same data but
optionally to a different address
parameters:
- in: path
name: id
required: true
description: The id of the Notification
schema:
type: string
tags:
- Notification
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
notification:
$ref: '#/components/schemas/notification'
/gift-cards:
post:
operationId: PostGiftCards
@@ -867,49 +910,6 @@ paths:
properties:
gift_card:
$ref: '#/components/schemas/gift_card'
/notifications:
get:
operationId: GetNotifications
summary: List Notifications
description: Retrieves a list of Notifications.
tags:
- Notification
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
notifications:
type: array
items:
$ref: '#/components/schemas/notification'
'/notifications/{id}/resend':
post:
operationId: PostNotificationsNotificationResend
summary: Resend Notification
description: >-
Resends a previously sent notifications, with the same data but
optionally to a different address
parameters:
- in: path
name: id
required: true
description: The id of the Notification
schema:
type: string
tags:
- Notification
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
notification:
$ref: '#/components/schemas/notification'
'/orders/{id}/shipping-methods':
post:
operationId: PostOrdersOrderShippingMethods
@@ -1511,8 +1511,10 @@ paths:
application/json:
schema:
properties:
order:
$ref: '#/components/schemas/order'
orders:
type: array
items:
$ref: '#/components/schemas/order'
'/orders/{id}/swaps/{swap_id}/process-payment':
post:
operationId: PostOrdersOrderSwapsSwapProcessPayment
@@ -3480,6 +3482,24 @@ paths:
properties:
shipping_profiles:
$ref: '#/components/schemas/shipping_profile'
/swaps:
get:
operationId: GetSwaps
summary: List Swaps
description: Retrieves a list of Swaps.
tags:
- Swap
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
swaps:
type: array
items:
$ref: '#/components/schemas/swap'
'/store/currencies/{code}':
post:
operationId: PostStoreCurrenciesCode
@@ -3590,24 +3610,6 @@ paths:
type: array
items:
$ref: '#/components/schemas/store'
/swaps:
get:
operationId: GetSwaps
summary: List Swaps
description: Retrieves a list of Swaps.
tags:
- Swap
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
swaps:
type: array
items:
$ref: '#/components/schemas/swap'
/variants:
get:
operationId: GetVariants

512
docs/api/fixtures.json
View File

@@ -1,7 +1,7 @@
{
"resources": {
"customer": {
"id": "cus_01F0BGFY6ANPB473KJ5H8V889M",
"id": "cus_01F0VY3BQPZZTZGWHPPNVW87RP",
"email": "test1@email.com",
"first_name": null,
"last_name": null,
@@ -10,21 +10,21 @@
"phone": null,
"has_account": false,
"orders": [],
"created_at": "2021-03-09T12:48:21.706Z",
"updated_at": "2021-03-09T12:48:21.706Z",
"created_at": "2021-03-15T21:54:00.566Z",
"updated_at": "2021-03-15T21:54:00.566Z",
"deleted_at": null,
"metadata": null
},
"order": {
"id": "order_01F0BGFG2Z0X0ETETP0YS0HRCT",
"id": "order_01F0VY2B8H3S6R3W6EY4QMKWG1",
"status": "pending",
"fulfillment_status": "not_fulfilled",
"payment_status": "not_paid",
"display_id": 1,
"cart_id": null,
"customer_id": "cus_01F0BGFG280DRD18VXM1F9GJXA",
"customer_id": "cus_01F0VY2B7Y2Y18PDQZMGWB0VF0",
"customer": {
"id": "cus_01F0BGFG280DRD18VXM1F9GJXA",
"id": "cus_01F0VY2B7Y2Y18PDQZMGWB0VF0",
"email": "test@email.com",
"first_name": null,
"last_name": null,
@@ -32,14 +32,14 @@
"password_hash": null,
"phone": null,
"has_account": false,
"created_at": "2021-03-09T12:48:07.240Z",
"updated_at": "2021-03-09T12:48:07.240Z",
"created_at": "2021-03-15T21:53:27.294Z",
"updated_at": "2021-03-15T21:53:27.294Z",
"deleted_at": null,
"metadata": null
},
"email": "test@email.com",
"billing_address": {
"id": "addr_01F0BGFG30PG1NP6V0EDJDF6PW",
"id": "addr_01F0VY2B8HSF0DGYRRMKAD0QE4",
"customer_id": null,
"company": null,
"first_name": "lebron",
@@ -51,13 +51,13 @@
"province": null,
"postal_code": null,
"phone": null,
"created_at": "2021-03-09T12:48:07.263Z",
"updated_at": "2021-03-09T12:48:07.263Z",
"created_at": "2021-03-15T21:53:27.313Z",
"updated_at": "2021-03-15T21:53:27.313Z",
"deleted_at": null,
"metadata": null
},
"shipping_address": {
"id": "addr_01F0BGFG30EBKX6C89N35YB2PX",
"id": "addr_01F0VY2B8HXBT67KYXJKMEDYR4",
"customer_id": null,
"company": null,
"first_name": "lebron",
@@ -69,22 +69,22 @@
"province": null,
"postal_code": null,
"phone": null,
"created_at": "2021-03-09T12:48:07.263Z",
"updated_at": "2021-03-09T12:48:07.263Z",
"created_at": "2021-03-15T21:53:27.313Z",
"updated_at": "2021-03-15T21:53:27.313Z",
"deleted_at": null,
"metadata": null
},
"region_id": "reg_01F0BGFG21NC3VQ662FYNF3P4Z",
"region_id": "reg_01F0VY2B7RAKG6PSVJ47KQP0PA",
"region": {
"id": "reg_01F0BGFG21NC3VQ662FYNF3P4Z",
"id": "reg_01F0VY2B7RAKG6PSVJ47KQP0PA",
"name": "Test Region",
"currency_code": "usd",
"tax_rate": "0",
"tax_code": null,
"payment_providers": [],
"fulfillment_providers": [],
"created_at": "2021-03-09T12:48:07.233Z",
"updated_at": "2021-03-09T12:48:07.233Z",
"created_at": "2021-03-15T21:53:27.287Z",
"updated_at": "2021-03-15T21:53:27.287Z",
"deleted_at": null,
"metadata": null
},
@@ -95,25 +95,25 @@
"id": "test-discount",
"code": "TEST134",
"is_dynamic": false,
"rule_id": "dru_01F0BGFG30S3FSBE67PKDCTT0Y",
"rule_id": "dru_01F0VY2B8H55AYVCW47B8DWMCN",
"rule": {
"id": "dru_01F0BGFG30S3FSBE67PKDCTT0Y",
"id": "dru_01F0VY2B8H55AYVCW47B8DWMCN",
"description": "Test Discount",
"type": "percentage",
"value": 10,
"allocation": "total",
"usage_limit": null,
"created_at": "2021-03-09T12:48:07.263Z",
"updated_at": "2021-03-09T12:48:07.263Z",
"created_at": "2021-03-15T21:53:27.313Z",
"updated_at": "2021-03-15T21:53:27.313Z",
"deleted_at": null,
"metadata": null
},
"is_disabled": false,
"parent_discount_id": null,
"starts_at": "2021-03-09T12:48:07.263Z",
"starts_at": "2021-03-15T21:53:27.313Z",
"ends_at": null,
"created_at": "2021-03-09T12:48:07.263Z",
"updated_at": "2021-03-09T12:48:07.263Z",
"created_at": "2021-03-15T21:53:27.313Z",
"updated_at": "2021-03-15T21:53:27.313Z",
"deleted_at": null,
"metadata": null
}
@@ -121,25 +121,25 @@
"gift_cards": [],
"shipping_methods": [
{
"id": "sm_01F0BGFG3SQZC01D8JP4REY0RF",
"shipping_option_id": "so_01F0BGFG2DV0GR6VD87AQ7XAB2",
"order_id": "order_01F0BGFG2Z0X0ETETP0YS0HRCT",
"id": "sm_01F0VY2B9DGWC1W2TDHHPBZD4Q",
"shipping_option_id": "so_01F0VY2B81KREYYVHH2SJQJ2NA",
"order_id": "order_01F0VY2B8H3S6R3W6EY4QMKWG1",
"claim_order_id": null,
"cart_id": null,
"swap_id": null,
"return_id": null,
"shipping_option": {
"id": "so_01F0BGFG2DV0GR6VD87AQ7XAB2",
"id": "so_01F0VY2B81KREYYVHH2SJQJ2NA",
"name": "test-option",
"region_id": "reg_01F0BGFG21NC3VQ662FYNF3P4Z",
"profile_id": "sp_01F0BGFG04GKTA9FTYWBT19NKJ",
"region_id": "reg_01F0VY2B7RAKG6PSVJ47KQP0PA",
"profile_id": "sp_01F0VY2B5KMSAXMSD449SFG005",
"provider_id": "test-ful",
"price_type": "flat_rate",
"amount": 1000,
"is_return": false,
"data": {},
"created_at": "2021-03-09T12:48:07.245Z",
"updated_at": "2021-03-09T12:48:07.245Z",
"created_at": "2021-03-15T21:53:27.297Z",
"updated_at": "2021-03-15T21:53:27.297Z",
"deleted_at": null,
"metadata": null
},
@@ -152,7 +152,7 @@
"id": "test-payment",
"swap_id": null,
"cart_id": null,
"order_id": "order_01F0BGFG2Z0X0ETETP0YS0HRCT",
"order_id": "order_01F0VY2B8H3S6R3W6EY4QMKWG1",
"amount": 10000,
"currency_code": "usd",
"amount_refunded": 0,
@@ -160,8 +160,8 @@
"data": {},
"captured_at": null,
"canceled_at": null,
"created_at": "2021-03-09T12:48:07.263Z",
"updated_at": "2021-03-09T12:48:07.263Z",
"created_at": "2021-03-15T21:53:27.313Z",
"updated_at": "2021-03-15T21:53:27.313Z",
"metadata": null,
"idempotency_key": null
}
@@ -175,7 +175,7 @@
{
"id": "test-item",
"cart_id": null,
"order_id": "order_01F0BGFG2Z0X0ETETP0YS0HRCT",
"order_id": "order_01F0VY2B8H3S6R3W6EY4QMKWG1",
"swap_id": null,
"claim_order_id": null,
"title": "Line Item",
@@ -192,16 +192,16 @@
"fulfilled_quantity": 1,
"returned_quantity": null,
"shipped_quantity": null,
"created_at": "2021-03-09T12:48:07.263Z",
"updated_at": "2021-03-09T12:48:07.263Z",
"created_at": "2021-03-15T21:53:27.313Z",
"updated_at": "2021-03-15T21:53:27.313Z",
"metadata": null,
"refundable": 7200
}
],
"gift_card_transactions": [],
"canceled_at": null,
"created_at": "2021-03-09T12:48:07.263Z",
"updated_at": "2021-03-09T12:48:07.263Z",
"created_at": "2021-03-15T21:53:27.313Z",
"updated_at": "2021-03-15T21:53:27.313Z",
"metadata": null,
"shipping_total": 1000,
"gift_card_total": 0,
@@ -213,7 +213,7 @@
"refundable_amount": 8200
},
"product": {
"id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
"id": "prod_01F0VY2HP5Z742ZQJ88G8K88XA",
"title": "Test product",
"subtitle": null,
"description": "test-product-description",
@@ -223,38 +223,38 @@
"thumbnail": null,
"options": [
{
"id": "opt_01F0BGG4N2W8EZJP5KDV0W2250",
"id": "opt_01F0VY2HPB68E6XV3JNRW000TW",
"title": "size",
"product_id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"product_id": "prod_01F0VY2HP5Z742ZQJ88G8K88XA",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
},
{
"id": "opt_01F0BGG4N3Q09ME0BEZG6XZGFQ",
"id": "opt_01F0VY2HPBK73EGMPH4XP2ZH1M",
"title": "color",
"product_id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"product_id": "prod_01F0VY2HP5Z742ZQJ88G8K88XA",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
}
],
"variants": [
{
"id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
"id": "variant_01F0VY2HQ5FCB5CZS651SY4YDJ",
"title": "Test variant",
"product_id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
"product_id": "prod_01F0VY2HP5Z742ZQJ88G8K88XA",
"product": {
"id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
"id": "prod_01F0VY2HP5Z742ZQJ88G8K88XA",
"title": "Test product",
"subtitle": null,
"description": "test-product-description",
"handle": "test-product",
"is_giftcard": false,
"thumbnail": null,
"profile_id": "sp_01F0BGG4J2RGH25WZVP8S6VNGW",
"profile_id": "sp_01F0VY2HHYESK5JG3NSDWBH0EX",
"weight": null,
"length": null,
"height": null,
@@ -265,21 +265,21 @@
"material": null,
"collection_id": "test-collection",
"type_id": "test-type",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
},
"prices": [
{
"id": "ma_01F0BGG4P5K0TCMD72MJFS0M65",
"id": "ma_01F0VY2HQA993M711M9F2QZ5K8",
"currency_code": "usd",
"amount": 100,
"sale_amount": null,
"variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
"variant_id": "variant_01F0VY2HQ5FCB5CZS651SY4YDJ",
"region_id": null,
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null
}
],
@@ -300,33 +300,33 @@
"width": null,
"options": [
{
"id": "optval_01F0BGG4NY1PRPV3FXQ3J66GQH",
"id": "optval_01F0VY2HQ5WSBTQP2VC67ZFY9V",
"value": "large",
"option_id": "opt_01F0BGG4N2W8EZJP5KDV0W2250",
"variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"option_id": "opt_01F0VY2HPB68E6XV3JNRW000TW",
"variant_id": "variant_01F0VY2HQ5FCB5CZS651SY4YDJ",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
},
{
"id": "optval_01F0BGG4NYTMFH5EXJ4C7QAKSK",
"id": "optval_01F0VY2HQ5HEQPKWPZ9R85YVWS",
"value": "green",
"option_id": "opt_01F0BGG4N3Q09ME0BEZG6XZGFQ",
"variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"option_id": "opt_01F0VY2HPBK73EGMPH4XP2ZH1M",
"variant_id": "variant_01F0VY2HQ5FCB5CZS651SY4YDJ",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
}
],
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
}
],
"profile_id": "sp_01F0BGG4J2RGH25WZVP8S6VNGW",
"profile_id": "sp_01F0VY2HHYESK5JG3NSDWBH0EX",
"weight": null,
"length": null,
"height": null,
@@ -340,8 +340,8 @@
"id": "test-collection",
"title": "Test collection",
"handle": null,
"created_at": "2021-03-09T12:48:28.250Z",
"updated_at": "2021-03-09T12:48:28.250Z",
"created_at": "2021-03-15T21:53:33.797Z",
"updated_at": "2021-03-15T21:53:33.797Z",
"deleted_at": null,
"metadata": null
},
@@ -349,8 +349,8 @@
"type": {
"id": "test-type",
"value": "test-type",
"created_at": "2021-03-09T12:48:28.260Z",
"updated_at": "2021-03-09T12:48:28.260Z",
"created_at": "2021-03-15T21:53:33.813Z",
"updated_at": "2021-03-15T21:53:33.813Z",
"deleted_at": null,
"metadata": null
},
@@ -358,32 +358,32 @@
{
"id": "tag1",
"value": "123",
"created_at": "2021-03-09T12:48:28.257Z",
"updated_at": "2021-03-09T12:48:28.257Z",
"created_at": "2021-03-15T21:53:33.809Z",
"updated_at": "2021-03-15T21:53:33.809Z",
"deleted_at": null,
"metadata": null
},
{
"id": "ptag_01F0BGG4MRHZSMYN9Q1YQZHPWT",
"id": "ptag_01F0VY2HP14MV8695X229DHGDT",
"value": "456",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
}
],
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"metadata": null
},
"cart": {
"id": "cart_01F0BGFQA6ETNHS7QGEZD9VTF2",
"id": "cart_01F0VYC80B1KK49045W4CZTHNW",
"email": null,
"billing_address_id": null,
"billing_address": null,
"shipping_address_id": "addr_01F0BGFQA6YF81V6CREDHNCZMZ",
"shipping_address_id": "addr_01F0VYC80BK976RK5HE7YB9A7S",
"shipping_address": {
"id": "addr_01F0BGFQA6YF81V6CREDHNCZMZ",
"id": "addr_01F0VYC80BK976RK5HE7YB9A7S",
"customer_id": null,
"company": null,
"first_name": null,
@@ -395,8 +395,8 @@
"province": null,
"postal_code": null,
"phone": null,
"created_at": "2021-03-09T12:48:14.638Z",
"updated_at": "2021-03-09T12:48:14.638Z",
"created_at": "2021-03-15T21:58:51.632Z",
"updated_at": "2021-03-15T21:58:51.632Z",
"deleted_at": null,
"metadata": null
},
@@ -421,8 +421,8 @@
],
"payment_providers": [],
"fulfillment_providers": [],
"created_at": "2021-03-09T12:48:14.601Z",
"updated_at": "2021-03-09T12:48:14.601Z",
"created_at": "2021-03-15T21:58:51.602Z",
"updated_at": "2021-03-15T21:58:51.602Z",
"deleted_at": null,
"metadata": null
},
@@ -435,8 +435,8 @@
"shipping_methods": [],
"type": "default",
"completed_at": null,
"created_at": "2021-03-09T12:48:14.638Z",
"updated_at": "2021-03-09T12:48:14.777Z",
"created_at": "2021-03-15T21:58:51.632Z",
"updated_at": "2021-03-15T21:58:51.757Z",
"deleted_at": null,
"metadata": null,
"idempotency_key": null,
@@ -448,53 +448,53 @@
"total": 0
},
"product_collection": {
"id": "pcol_01F0BGG81W0FERCAHMR79J72G8",
"id": "pcol_01F0VY3W9433C9Q2JGZC1MVFYQ",
"title": "Summer Collection",
"handle": "summer-collection",
"created_at": "2021-03-09T12:48:31.804Z",
"updated_at": "2021-03-09T12:48:31.804Z",
"created_at": "2021-03-15T21:54:17.507Z",
"updated_at": "2021-03-15T21:54:17.507Z",
"deleted_at": null,
"metadata": null
},
"discount": {
"id": "disc_01F0BGG1BJH91HJ7J9Q0NR0BR6",
"id": "disc_01F0VYCE742WAYBT38HNSVWZP6",
"code": "10DISC",
"is_dynamic": false,
"rule_id": "dru_01F0BGG1B3BCZ292BSRRK72JGS",
"rule_id": "dru_01F0VYCE6R1QV0DFT64EXGGVA2",
"rule": {
"id": "dru_01F0BGG1B3BCZ292BSRRK72JGS",
"id": "dru_01F0VYCE6R1QV0DFT64EXGGVA2",
"description": "10 Percent",
"type": "percentage",
"value": 10,
"allocation": "total",
"usage_limit": null,
"created_at": "2021-03-09T12:48:24.921Z",
"updated_at": "2021-03-09T12:48:24.921Z",
"created_at": "2021-03-15T21:58:57.998Z",
"updated_at": "2021-03-15T21:58:57.998Z",
"deleted_at": null,
"metadata": null
},
"is_disabled": false,
"parent_discount_id": null,
"starts_at": "2021-03-09T12:48:24.921Z",
"starts_at": "2021-03-15T21:58:57.998Z",
"ends_at": null,
"created_at": "2021-03-09T12:48:24.921Z",
"updated_at": "2021-03-09T12:48:24.921Z",
"created_at": "2021-03-15T21:58:57.998Z",
"updated_at": "2021-03-15T21:58:57.998Z",
"deleted_at": null,
"metadata": null
},
"product_variant": {
"id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
"id": "variant_01F0VY2HQ5FCB5CZS651SY4YDJ",
"title": "Test variant",
"product_id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
"product_id": "prod_01F0VY2HP5Z742ZQJ88G8K88XA",
"product": {
"id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
"id": "prod_01F0VY2HP5Z742ZQJ88G8K88XA",
"title": "Test product",
"subtitle": null,
"description": "test-product-description",
"handle": "test-product",
"is_giftcard": false,
"thumbnail": null,
"profile_id": "sp_01F0BGG4J2RGH25WZVP8S6VNGW",
"profile_id": "sp_01F0VY2HHYESK5JG3NSDWBH0EX",
"weight": null,
"length": null,
"height": null,
@@ -505,21 +505,21 @@
"material": null,
"collection_id": "test-collection",
"type_id": "test-type",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
},
"prices": [
{
"id": "ma_01F0BGG4P5K0TCMD72MJFS0M65",
"id": "ma_01F0VY2HQA993M711M9F2QZ5K8",
"currency_code": "usd",
"amount": 100,
"sale_amount": null,
"variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
"variant_id": "variant_01F0VY2HQ5FCB5CZS651SY4YDJ",
"region_id": null,
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null
}
],
@@ -540,93 +540,93 @@
"width": null,
"options": [
{
"id": "optval_01F0BGG4NY1PRPV3FXQ3J66GQH",
"id": "optval_01F0VY2HQ5WSBTQP2VC67ZFY9V",
"value": "large",
"option_id": "opt_01F0BGG4N2W8EZJP5KDV0W2250",
"variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"option_id": "opt_01F0VY2HPB68E6XV3JNRW000TW",
"variant_id": "variant_01F0VY2HQ5FCB5CZS651SY4YDJ",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
},
{
"id": "optval_01F0BGG4NYTMFH5EXJ4C7QAKSK",
"id": "optval_01F0VY2HQ5HEQPKWPZ9R85YVWS",
"value": "green",
"option_id": "opt_01F0BGG4N3Q09ME0BEZG6XZGFQ",
"variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"option_id": "opt_01F0VY2HPBK73EGMPH4XP2ZH1M",
"variant_id": "variant_01F0VY2HQ5FCB5CZS651SY4YDJ",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
}
],
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
},
"product_option": {
"id": "opt_01F0BGG4N2W8EZJP5KDV0W2250",
"id": "opt_01F0VY2HPB68E6XV3JNRW000TW",
"title": "size",
"product_id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"product_id": "prod_01F0VY2HP5Z742ZQJ88G8K88XA",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
},
"product_option_value": {
"id": "optval_01F0BGG4NY1PRPV3FXQ3J66GQH",
"id": "optval_01F0VY2HQ5WSBTQP2VC67ZFY9V",
"value": "large",
"option_id": "opt_01F0BGG4N2W8EZJP5KDV0W2250",
"variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"option_id": "opt_01F0VY2HPB68E6XV3JNRW000TW",
"variant_id": "variant_01F0VY2HQ5FCB5CZS651SY4YDJ",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null,
"metadata": null
},
"money_amount": {
"id": "ma_01F0BGG4P5K0TCMD72MJFS0M65",
"id": "ma_01F0VY2HQA993M711M9F2QZ5K8",
"currency_code": "usd",
"amount": 100,
"sale_amount": null,
"variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
"variant_id": "variant_01F0VY2HQ5FCB5CZS651SY4YDJ",
"region_id": null,
"created_at": "2021-03-09T12:48:28.304Z",
"updated_at": "2021-03-09T12:48:28.304Z",
"created_at": "2021-03-15T21:53:33.884Z",
"updated_at": "2021-03-15T21:53:33.884Z",
"deleted_at": null
},
"gift_card": {
"id": "gift_01F0BF6H3XHRT2SF4Y05AM95B9",
"code": "HRYB-SMX4-XXQN-2SRL",
"id": "gift_01F0VY36MYBD8QJJX560HAMK08",
"code": "CUHS-0X5J-GL91-UQZE",
"value": 1000,
"balance": 1000,
"region_id": "reg_01F0BF6H2MZ06R2G2ZGZCAX3NS",
"region_id": "reg_01F0VY36JGWMSQDSKEA95QR4PJ",
"region": {
"id": "reg_01F0BF6H2MZ06R2G2ZGZCAX3NS",
"id": "reg_01F0VY36JGWMSQDSKEA95QR4PJ",
"name": "Test Region",
"currency_code": "usd",
"tax_rate": "0",
"tax_code": null,
"payment_providers": [],
"fulfillment_providers": [],
"created_at": "2021-03-09T12:25:44.788Z",
"updated_at": "2021-03-09T12:25:44.788Z",
"created_at": "2021-03-15T21:53:55.279Z",
"updated_at": "2021-03-15T21:53:55.279Z",
"deleted_at": null,
"metadata": null
},
"is_disabled": false,
"ends_at": null,
"created_at": "2021-03-09T12:25:44.818Z",
"updated_at": "2021-03-09T12:25:44.818Z",
"created_at": "2021-03-15T21:53:55.325Z",
"updated_at": "2021-03-15T21:53:55.325Z",
"deleted_at": null,
"metadata": null
},
"shipping_option": {
"id": "so_01F0BGFTXZ6V3GAJHBKHNTR54H",
"id": "so_01F0VY2QV5RYPD9HN1S5SQZPQ5",
"name": "Free Shipping",
"region_id": "reg_01F0BGFTW7J0DGWKJJP3X7AWP9",
"region_id": "reg_01F0VY2QSCPG4F8KC9RN2R439T",
"region": {
"id": "reg_01F0BGFTW7J0DGWKJJP3X7AWP9",
"id": "reg_01F0VY2QSCPG4F8KC9RN2R439T",
"name": "Test Region",
"currency_code": "usd",
"tax_rate": "0",
@@ -638,18 +638,18 @@
"is_installed": true
}
],
"created_at": "2021-03-09T12:48:18.311Z",
"updated_at": "2021-03-09T12:48:18.311Z",
"created_at": "2021-03-15T21:53:40.140Z",
"updated_at": "2021-03-15T21:53:40.140Z",
"deleted_at": null,
"metadata": null
},
"profile_id": "sp_01F0BGFTVGXRBATSDBZN5SK2JP",
"profile_id": "sp_01F0VY2QRT5C25T0QHSD8EEKA4",
"profile": {
"id": "sp_01F0BGFTVGXRBATSDBZN5SK2JP",
"id": "sp_01F0VY2QRT5C25T0QHSD8EEKA4",
"name": "Default Shipping Profile",
"type": "default",
"created_at": "2021-03-09T12:48:18.240Z",
"updated_at": "2021-03-09T12:48:18.240Z",
"created_at": "2021-03-15T21:53:40.068Z",
"updated_at": "2021-03-15T21:53:40.068Z",
"deleted_at": null,
"metadata": null
},
@@ -659,13 +659,13 @@
"is_return": false,
"requirements": [],
"data": {},
"created_at": "2021-03-09T12:48:18.354Z",
"updated_at": "2021-03-09T12:48:18.354Z",
"created_at": "2021-03-15T21:53:40.185Z",
"updated_at": "2021-03-15T21:53:40.185Z",
"deleted_at": null,
"metadata": null
},
"region": {
"id": "reg_01F0BGFTW7J0DGWKJJP3X7AWP9",
"id": "reg_01F0VY2QSCPG4F8KC9RN2R439T",
"name": "Test Region",
"currency_code": "usd",
"tax_rate": "0",
@@ -677,17 +677,17 @@
"is_installed": true
}
],
"created_at": "2021-03-09T12:48:18.311Z",
"updated_at": "2021-03-09T12:48:18.311Z",
"created_at": "2021-03-15T21:53:40.140Z",
"updated_at": "2021-03-15T21:53:40.140Z",
"deleted_at": null,
"metadata": null
},
"return": {
"id": "ret_01F0BGFGGVWNV93E789K1DB2QK",
"id": "ret_01F0VY2BN9RSJC6GTJRG3C03X6",
"status": "requested",
"items": [
{
"return_id": "ret_01F0BGFGGVWNV93E789K1DB2QK",
"return_id": "ret_01F0VY2BN9RSJC6GTJRG3C03X6",
"item_id": "test-item",
"quantity": 1,
"is_requested": true,
@@ -698,38 +698,204 @@
],
"swap_id": null,
"claim_order_id": null,
"order_id": "order_01F0BGFGBMCTXE6CD7KCTZG5D1",
"order_id": "order_01F0VY2BGM5TWR3PNX28SVD0MS",
"shipping_method": null,
"shipping_data": null,
"refund_amount": 7200,
"received_at": null,
"created_at": "2021-03-09T12:48:07.680Z",
"updated_at": "2021-03-09T12:48:07.680Z",
"created_at": "2021-03-15T21:53:27.696Z",
"updated_at": "2021-03-15T21:53:27.696Z",
"metadata": null,
"idempotency_key": "abb55222-1d22-4852-9714-9b63baec3633"
"idempotency_key": "5992adb7-b4f9-440c-a8c2-147966807d9a"
},
"notification": {
"id": "noti_01F0BGFKZ7P3NC5V1PG10S75N0",
"id": "noti_01F0VY31P10A09S6JTJM2GYV7V",
"resource_type": "order",
"resource_id": "order_01F0BF66ZBXNJ98WDQ9SCWH8Y7",
"event_name": "order.placed",
"to": "test@email.com",
"provider_id": "test-not",
"created_at": "2021-03-09T12:48:11.238Z",
"updated_at": "2021-03-09T12:48:11.238Z",
"created_at": "2021-03-15T21:53:50.273Z",
"updated_at": "2021-03-15T21:53:50.273Z",
"resends": []
},
"discount_rule": {
"id": "dru_01F0BGG1B3BCZ292BSRRK72JGS",
"id": "dru_01F0VYCE6R1QV0DFT64EXGGVA2",
"description": "10 Percent",
"type": "percentage",
"value": 10,
"allocation": "total",
"usage_limit": null,
"created_at": "2021-03-09T12:48:24.921Z",
"updated_at": "2021-03-09T12:48:24.921Z",
"created_at": "2021-03-15T21:58:57.998Z",
"updated_at": "2021-03-15T21:58:57.998Z",
"deleted_at": null,
"metadata": null
},
"user": {
"id": "admin_user",
"email": "admin@medusa.js",
"first_name": null,
"last_name": null,
"api_token": "test_token",
"created_at": "2021-03-15T21:54:22.223Z",
"updated_at": "2021-03-15T21:54:22.223Z",
"deleted_at": null,
"metadata": null
},
"shipping_profile": {
"id": "sp_01F0VY3GHMP2QKQJDF12ZVNQ71",
"name": "Default Shipping Profile",
"type": "default",
"created_at": "2021-03-15T21:54:05.417Z",
"updated_at": "2021-03-15T21:54:05.417Z",
"deleted_at": null,
"metadata": null
},
"store": {
"id": "store_01F0VYDX7S2T0KPWYG3VN018AZ",
"name": "Medusa Store",
"default_currency_code": "usd",
"default_currency": {
"code": "usd",
"symbol": "$",
"symbol_native": "$",
"name": "US Dollar"
},
"currencies": [],
"swap_link_template": null,
"created_at": "2021-03-15T21:59:46.161Z",
"updated_at": "2021-03-15T21:59:46.161Z",
"metadata": null,
"payment_providers": [
{
"id": "test-pay",
"is_installed": true
}
],
"fulfillment_providers": [
{
"id": "test-ful",
"is_installed": true
}
]
},
"swap": {
"id": "swap_01F0WX73K6ED141YQX65J55D73",
"fulfillment_status": "not_fulfilled",
"payment_status": "not_paid",
"order_id": "order_01F0WX73B3WFZ24157M3AZR369",
"additional_items": [
{
"id": "item_01F0WX73K6Q7YSB929EPFR39E9",
"cart_id": "cart_01F0WX73ND08RYPZA1J91XTWV5",
"order_id": null,
"swap_id": "swap_01F0WX73K6ED141YQX65J55D73",
"claim_order_id": null,
"title": "test product",
"description": "test variant",
"thumbnail": null,
"is_giftcard": false,
"should_merge": true,
"allow_discounts": true,
"has_shipping": null,
"unit_price": 8000,
"variant_id": "variant_01F0WX739Y6BQZG8Y9PCK5XPRA",
"variant": {
"id": "variant_01F0WX739Y6BQZG8Y9PCK5XPRA",
"title": "test variant",
"product_id": "prod_01F0WX739NEKR6PK8XP0YD5FY8",
"product": {
"id": "prod_01F0WX739NEKR6PK8XP0YD5FY8",
"title": "test product",
"subtitle": null,
"description": null,
"handle": "test-product",
"is_giftcard": false,
"thumbnail": null,
"profile_id": "sp_01F0WX738N6YJ9KGK31YBPDHFK",
"weight": null,
"length": null,
"height": null,
"width": null,
"hs_code": null,
"origin_country": null,
"mid_code": null,
"material": null,
"collection_id": null,
"type_id": null,
"created_at": "2021-03-16T06:57:48.853Z",
"updated_at": "2021-03-16T06:57:48.853Z",
"deleted_at": null,
"metadata": null
},
"sku": null,
"barcode": null,
"ean": null,
"upc": null,
"inventory_quantity": 1,
"allow_backorder": false,
"manage_inventory": true,
"hs_code": null,
"origin_country": null,
"mid_code": null,
"material": null,
"weight": null,
"length": null,
"height": null,
"width": null,
"created_at": "2021-03-16T06:57:48.862Z",
"updated_at": "2021-03-16T06:57:48.862Z",
"deleted_at": null,
"metadata": null
},
"quantity": 2,
"fulfilled_quantity": null,
"returned_quantity": null,
"shipped_quantity": null,
"created_at": "2021-03-16T06:57:49.106Z",
"updated_at": "2021-03-16T06:57:49.106Z",
"metadata": {}
}
],
"return_order": {
"id": "ret_01F0WX73KBV2QAJPYZAGPDADVW",
"status": "requested",
"items": [
{
"return_id": "ret_01F0WX73KBV2QAJPYZAGPDADVW",
"item_id": "test-item",
"quantity": 1,
"is_requested": true,
"requested_quantity": 1,
"received_quantity": null,
"metadata": null
}
],
"swap_id": "swap_01F0WX73K6ED141YQX65J55D73",
"claim_order_id": null,
"order_id": null,
"shipping_method": null,
"shipping_data": null,
"refund_amount": 7200,
"received_at": null,
"created_at": "2021-03-16T06:57:49.106Z",
"updated_at": "2021-03-16T06:57:49.106Z",
"metadata": null,
"idempotency_key": null
},
"fulfillments": [],
"payment": null,
"difference_due": null,
"shipping_address_id": null,
"shipping_address": null,
"shipping_methods": [],
"cart_id": "cart_01F0WX73ND08RYPZA1J91XTWV5",
"confirmed_at": null,
"created_at": "2021-03-16T06:57:49.106Z",
"updated_at": "2021-03-16T06:57:49.106Z",
"deleted_at": null,
"metadata": null,
"idempotency_key": "360a87af-2ff7-4326-b557-042aa2ae331d"
}
}
}

1432
docs/api/store-spec3.json
View File

File diff suppressed because it is too large Load Diff

176
docs/api/store-spec3.yaml
View File

@@ -1025,56 +1025,6 @@ paths:
properties:
customer:
$ref: '#/components/schemas/customer'
'/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
@@ -1125,49 +1075,20 @@ paths:
type: array
items:
$ref: '#/components/schemas/region'
/shipping-options:
'/products/{id}':
get:
operationId: GetShippingOptions
summary: Retrieve Shipping Options
description: Retrieves a list of Shipping Options.
parameters:
- in: query
name: product_ids
description: A comma separated list of Product ids to filter Shipping Options by.
schema:
type: string
- in: query
name: region_id
description: the Region to retrieve Shipping Options from.
schema:
type: string
tags:
- Shipping Option
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
shipping_options:
type: array
items:
$ref: '#/components/schemas/shipping_option'
'/shipping-options/{cart_id}':
get:
operationId: GetShippingOptionsCartId
summary: Retrieve Shipping Options for Cart
description: Retrieves a list of Shipping Options available to a cart.
operationId: GetProductsProduct
summary: Retrieves a Product
description: Retrieves a Product.
parameters:
- in: path
name: cart_id
name: id
required: true
description: The id of the Cart.
description: The id of the Product.
schema:
type: string
tags:
- Shipping Option
- Product
responses:
'200':
description: OK
@@ -1175,10 +1096,35 @@ paths:
application/json:
schema:
properties:
shipping_options:
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/shipping_option'
$ref: '#/components/schemas/product'
'/swaps/{cart_id}':
get:
operationId: GetSwapsSwapCartId
@@ -1249,6 +1195,60 @@ paths:
type: array
items:
$ref: '#/components/schemas/product_variant'
/shipping-options:
get:
operationId: GetShippingOptions
summary: Retrieve Shipping Options
description: Retrieves a list of Shipping Options.
parameters:
- in: query
name: product_ids
description: A comma separated list of Product ids to filter Shipping Options by.
schema:
type: string
- in: query
name: region_id
description: the Region to retrieve Shipping Options from.
schema:
type: string
tags:
- Shipping Option
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
shipping_options:
type: array
items:
$ref: '#/components/schemas/shipping_option'
'/shipping-options/{cart_id}':
get:
operationId: GetShippingOptionsCartId
summary: Retrieve Shipping Options for Cart
description: Retrieves a list of Shipping Options available to a cart.
parameters:
- in: path
name: cart_id
required: true
description: The id of the Cart.
schema:
type: string
tags:
- Shipping Option
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
shipping_options:
type: array
items:
$ref: '#/components/schemas/shipping_option'
components:
schemas:
address: