chore(docs): Generated API Reference (v2) (#8100)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
1 parent
04819107dd
commit
3730b79472
9 files changed
+32
-236
No files matched your search
+2
-2
@@ -4,8 +4,8 @@ curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/ship
|
|||||||
--data-raw '{
|
--data-raw '{
|
||||||
"items": [
|
"items": [
|
||||||
{
|
{
|
||||||
"id": "id_5sTwO6Lz9h9W7f1U",
|
"id": "id_rnSpxwfxEfbXVCA7",
|
||||||
"quantity": 395722780311552
|
"quantity": 3643591194836992
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"metadata": {}
|
"metadata": {}
|
||||||
|
|||||||
-1
@@ -20,7 +20,6 @@ properties:
|
|||||||
- id
|
- id
|
||||||
- quantity
|
- quantity
|
||||||
- reason_id
|
- reason_id
|
||||||
- note
|
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
+7
-56
@@ -3,69 +3,20 @@ description: SUMMARY
|
|||||||
x-schemaName: AdminPostReturnsReqSchema
|
x-schemaName: AdminPostReturnsReqSchema
|
||||||
required:
|
required:
|
||||||
- order_id
|
- order_id
|
||||||
- items
|
- metadata
|
||||||
- internal_note
|
|
||||||
- location_id
|
|
||||||
properties:
|
properties:
|
||||||
order_id:
|
order_id:
|
||||||
type: string
|
type: string
|
||||||
title: order_id
|
title: order_id
|
||||||
description: The return's order id.
|
description: The return's order id.
|
||||||
items:
|
description:
|
||||||
type: array
|
|
||||||
description: The return's items.
|
|
||||||
items:
|
|
||||||
type: object
|
|
||||||
description: The item's items.
|
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- quantity
|
|
||||||
- reason_id
|
|
||||||
- note
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: description
|
||||||
description: The item's ID.
|
description: The return's description.
|
||||||
quantity:
|
|
||||||
type: number
|
|
||||||
title: quantity
|
|
||||||
description: The item's quantity.
|
|
||||||
reason_id:
|
|
||||||
type: string
|
|
||||||
title: reason_id
|
|
||||||
description: The item's reason id.
|
|
||||||
note:
|
|
||||||
type: string
|
|
||||||
title: note
|
|
||||||
description: The item's note.
|
|
||||||
return_shipping:
|
|
||||||
type: object
|
|
||||||
description: The return's return shipping.
|
|
||||||
required:
|
|
||||||
- option_id
|
|
||||||
properties:
|
|
||||||
option_id:
|
|
||||||
type: string
|
|
||||||
title: option_id
|
|
||||||
description: The return shipping's option id.
|
|
||||||
price:
|
|
||||||
type: number
|
|
||||||
title: price
|
|
||||||
description: The return shipping's price.
|
|
||||||
internal_note:
|
internal_note:
|
||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The return's internal note.
|
description: The return's internal note.
|
||||||
receive_now:
|
metadata:
|
||||||
type: boolean
|
type: object
|
||||||
title: receive_now
|
description: The return's metadata.
|
||||||
description: The return's receive now.
|
|
||||||
refund_amount:
|
|
||||||
type: number
|
|
||||||
title: refund_amount
|
|
||||||
description: The return's refund amount.
|
|
||||||
location_id:
|
|
||||||
type: string
|
|
||||||
title: location_id
|
|
||||||
description: The return's location id.
|
|
||||||
@@ -2,7 +2,6 @@ type: object
|
|||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateCustomerGroup
|
x-schemaName: AdminUpdateCustomerGroup
|
||||||
required:
|
required:
|
||||||
- name
|
|
||||||
- metadata
|
- metadata
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
|
|||||||
@@ -7612,8 +7612,8 @@ paths:
|
|||||||
--data-raw '{
|
--data-raw '{
|
||||||
"items": [
|
"items": [
|
||||||
{
|
{
|
||||||
"id": "id_5sTwO6Lz9h9W7f1U",
|
"id": "id_rnSpxwfxEfbXVCA7",
|
||||||
"quantity": 395722780311552
|
"quantity": 3643591194836992
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"metadata": {}
|
"metadata": {}
|
||||||
@@ -39931,7 +39931,6 @@ components:
|
|||||||
- id
|
- id
|
||||||
- quantity
|
- quantity
|
||||||
- reason_id
|
- reason_id
|
||||||
- note
|
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
@@ -39959,72 +39958,23 @@ components:
|
|||||||
x-schemaName: AdminPostReturnsReqSchema
|
x-schemaName: AdminPostReturnsReqSchema
|
||||||
required:
|
required:
|
||||||
- order_id
|
- order_id
|
||||||
- items
|
- metadata
|
||||||
- internal_note
|
|
||||||
- location_id
|
|
||||||
properties:
|
properties:
|
||||||
order_id:
|
order_id:
|
||||||
type: string
|
type: string
|
||||||
title: order_id
|
title: order_id
|
||||||
description: The return's order id.
|
description: The return's order id.
|
||||||
items:
|
description:
|
||||||
type: array
|
|
||||||
description: The return's items.
|
|
||||||
items:
|
|
||||||
type: object
|
|
||||||
description: The item's items.
|
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- quantity
|
|
||||||
- reason_id
|
|
||||||
- note
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: description
|
||||||
description: The item's ID.
|
description: The return's description.
|
||||||
quantity:
|
|
||||||
type: number
|
|
||||||
title: quantity
|
|
||||||
description: The item's quantity.
|
|
||||||
reason_id:
|
|
||||||
type: string
|
|
||||||
title: reason_id
|
|
||||||
description: The item's reason id.
|
|
||||||
note:
|
|
||||||
type: string
|
|
||||||
title: note
|
|
||||||
description: The item's note.
|
|
||||||
return_shipping:
|
|
||||||
type: object
|
|
||||||
description: The return's return shipping.
|
|
||||||
required:
|
|
||||||
- option_id
|
|
||||||
properties:
|
|
||||||
option_id:
|
|
||||||
type: string
|
|
||||||
title: option_id
|
|
||||||
description: The return shipping's option id.
|
|
||||||
price:
|
|
||||||
type: number
|
|
||||||
title: price
|
|
||||||
description: The return shipping's price.
|
|
||||||
internal_note:
|
internal_note:
|
||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The return's internal note.
|
description: The return's internal note.
|
||||||
receive_now:
|
metadata:
|
||||||
type: boolean
|
type: object
|
||||||
title: receive_now
|
description: The return's metadata.
|
||||||
description: The return's receive now.
|
|
||||||
refund_amount:
|
|
||||||
type: number
|
|
||||||
title: refund_amount
|
|
||||||
description: The return's refund amount.
|
|
||||||
location_id:
|
|
||||||
type: string
|
|
||||||
title: location_id
|
|
||||||
description: The return's location id.
|
|
||||||
AdminPrice:
|
AdminPrice:
|
||||||
type: object
|
type: object
|
||||||
description: The price's prices.
|
description: The price's prices.
|
||||||
@@ -41275,7 +41225,6 @@ components:
|
|||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateCustomerGroup
|
x-schemaName: AdminUpdateCustomerGroup
|
||||||
required:
|
required:
|
||||||
- name
|
|
||||||
- metadata
|
- metadata
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
|
|||||||
-1
@@ -20,7 +20,6 @@ properties:
|
|||||||
- id
|
- id
|
||||||
- quantity
|
- quantity
|
||||||
- reason_id
|
- reason_id
|
||||||
- note
|
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
+7
-56
@@ -3,69 +3,20 @@ description: SUMMARY
|
|||||||
x-schemaName: AdminPostReturnsReqSchema
|
x-schemaName: AdminPostReturnsReqSchema
|
||||||
required:
|
required:
|
||||||
- order_id
|
- order_id
|
||||||
- items
|
- metadata
|
||||||
- internal_note
|
|
||||||
- location_id
|
|
||||||
properties:
|
properties:
|
||||||
order_id:
|
order_id:
|
||||||
type: string
|
type: string
|
||||||
title: order_id
|
title: order_id
|
||||||
description: The return's order id.
|
description: The return's order id.
|
||||||
items:
|
description:
|
||||||
type: array
|
|
||||||
description: The return's items.
|
|
||||||
items:
|
|
||||||
type: object
|
|
||||||
description: The item's items.
|
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- quantity
|
|
||||||
- reason_id
|
|
||||||
- note
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: description
|
||||||
description: The item's ID.
|
description: The return's description.
|
||||||
quantity:
|
|
||||||
type: number
|
|
||||||
title: quantity
|
|
||||||
description: The item's quantity.
|
|
||||||
reason_id:
|
|
||||||
type: string
|
|
||||||
title: reason_id
|
|
||||||
description: The item's reason id.
|
|
||||||
note:
|
|
||||||
type: string
|
|
||||||
title: note
|
|
||||||
description: The item's note.
|
|
||||||
return_shipping:
|
|
||||||
type: object
|
|
||||||
description: The return's return shipping.
|
|
||||||
required:
|
|
||||||
- option_id
|
|
||||||
properties:
|
|
||||||
option_id:
|
|
||||||
type: string
|
|
||||||
title: option_id
|
|
||||||
description: The return shipping's option id.
|
|
||||||
price:
|
|
||||||
type: number
|
|
||||||
title: price
|
|
||||||
description: The return shipping's price.
|
|
||||||
internal_note:
|
internal_note:
|
||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The return's internal note.
|
description: The return's internal note.
|
||||||
receive_now:
|
metadata:
|
||||||
type: boolean
|
type: object
|
||||||
title: receive_now
|
description: The return's metadata.
|
||||||
description: The return's receive now.
|
|
||||||
refund_amount:
|
|
||||||
type: number
|
|
||||||
title: refund_amount
|
|
||||||
description: The return's refund amount.
|
|
||||||
location_id:
|
|
||||||
type: string
|
|
||||||
title: location_id
|
|
||||||
description: The return's location id.
|
|
||||||
@@ -2,7 +2,6 @@ type: object
|
|||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateCustomerGroup
|
x-schemaName: AdminUpdateCustomerGroup
|
||||||
required:
|
required:
|
||||||
- name
|
|
||||||
- metadata
|
- metadata
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
|
|||||||
@@ -5140,7 +5140,6 @@ components:
|
|||||||
- id
|
- id
|
||||||
- quantity
|
- quantity
|
||||||
- reason_id
|
- reason_id
|
||||||
- note
|
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
@@ -5168,72 +5167,23 @@ components:
|
|||||||
x-schemaName: AdminPostReturnsReqSchema
|
x-schemaName: AdminPostReturnsReqSchema
|
||||||
required:
|
required:
|
||||||
- order_id
|
- order_id
|
||||||
- items
|
- metadata
|
||||||
- internal_note
|
|
||||||
- location_id
|
|
||||||
properties:
|
properties:
|
||||||
order_id:
|
order_id:
|
||||||
type: string
|
type: string
|
||||||
title: order_id
|
title: order_id
|
||||||
description: The return's order id.
|
description: The return's order id.
|
||||||
items:
|
description:
|
||||||
type: array
|
|
||||||
description: The return's items.
|
|
||||||
items:
|
|
||||||
type: object
|
|
||||||
description: The item's items.
|
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- quantity
|
|
||||||
- reason_id
|
|
||||||
- note
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
type: string
|
||||||
title: id
|
title: description
|
||||||
description: The item's ID.
|
description: The return's description.
|
||||||
quantity:
|
|
||||||
type: number
|
|
||||||
title: quantity
|
|
||||||
description: The item's quantity.
|
|
||||||
reason_id:
|
|
||||||
type: string
|
|
||||||
title: reason_id
|
|
||||||
description: The item's reason id.
|
|
||||||
note:
|
|
||||||
type: string
|
|
||||||
title: note
|
|
||||||
description: The item's note.
|
|
||||||
return_shipping:
|
|
||||||
type: object
|
|
||||||
description: The return's return shipping.
|
|
||||||
required:
|
|
||||||
- option_id
|
|
||||||
properties:
|
|
||||||
option_id:
|
|
||||||
type: string
|
|
||||||
title: option_id
|
|
||||||
description: The return shipping's option id.
|
|
||||||
price:
|
|
||||||
type: number
|
|
||||||
title: price
|
|
||||||
description: The return shipping's price.
|
|
||||||
internal_note:
|
internal_note:
|
||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The return's internal note.
|
description: The return's internal note.
|
||||||
receive_now:
|
metadata:
|
||||||
type: boolean
|
type: object
|
||||||
title: receive_now
|
description: The return's metadata.
|
||||||
description: The return's receive now.
|
|
||||||
refund_amount:
|
|
||||||
type: number
|
|
||||||
title: refund_amount
|
|
||||||
description: The return's refund amount.
|
|
||||||
location_id:
|
|
||||||
type: string
|
|
||||||
title: location_id
|
|
||||||
description: The return's location id.
|
|
||||||
AdminPrice:
|
AdminPrice:
|
||||||
type: object
|
type: object
|
||||||
description: The price's prices.
|
description: The price's prices.
|
||||||
@@ -6484,7 +6434,6 @@ components:
|
|||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
x-schemaName: AdminUpdateCustomerGroup
|
x-schemaName: AdminUpdateCustomerGroup
|
||||||
required:
|
required:
|
||||||
- name
|
|
||||||
- metadata
|
- metadata
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
|
|||||||
Reference in new issue
Block a user