chore(docs): Updated API Reference (automated) (#10258)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
73 files changed
+2943
-275
No files matched your search
@@ -357,7 +357,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: createOrdersWorkflow
|
||||
* x-workflow: createOrderWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
/**
|
||||
* @oas [post] /admin/orders/{id}/transfer
|
||||
* operationId: PostOrdersIdTransfer
|
||||
* x-sidebar-summary: Request Transfer
|
||||
* summary: Request Order Transfer
|
||||
* description: Request an order to be transfered to another customer. The transfer is confirmed by sending a request to the [Accept Order Transfer](https://docs.medusajs.com/api/store#orders_postordersidtransferaccept) Store API route.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The order's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: |-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. Without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminTransferOrder"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/admin/orders/{id}/transfer' \
|
||||
* -H 'Authorization: Bearer {access_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "customer_id": "cus_123"
|
||||
* }'
|
||||
* tags:
|
||||
* - Orders
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminOrderResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
* $ref: "#/components/responses/unauthorized"
|
||||
* "404":
|
||||
* $ref: "#/components/responses/not_found_error"
|
||||
* "409":
|
||||
* $ref: "#/components/responses/invalid_state_error"
|
||||
* "422":
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: requestOrderTransferWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+13
-9
@@ -1,8 +1,9 @@
|
||||
/**
|
||||
* @oas [post] /admin/orders/{id}
|
||||
* operationId: PostOrdersId
|
||||
* summary: Update an Order
|
||||
* description: Update an order's details.
|
||||
* @oas [post] /admin/orders/{id}/transfer/cancel
|
||||
* operationId: PostOrdersIdTransferCancel
|
||||
* summary: Cancel Transfer Request
|
||||
* x-sidebar-summary: Cancel Transfer
|
||||
* description: Cancel a request to transfer an order to another customer.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -13,14 +14,16 @@
|
||||
* type: string
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* description: |-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. Without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* security:
|
||||
@@ -31,7 +34,7 @@
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/admin/orders/{id}' \
|
||||
* curl -X POST '{backend_url}/admin/orders/{id}/transfer/cancel' \
|
||||
* -H 'Authorization: Bearer {access_token}'
|
||||
* tags:
|
||||
* - Orders
|
||||
@@ -54,6 +57,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: cancelOrderTransferRequestWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
/**
|
||||
* @oas [post] /store/carts/{id}/customer
|
||||
* operationId: PostCartsIdCustomer
|
||||
* summary: Set Cart's Customer
|
||||
* x-sidebar-summary: Set Customer
|
||||
* description: Set the customer of the cart. This is useful when you create the cart for a guest customer, then they log in with their account.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/resources/storefront-development/cart/update#set-carts-customer
|
||||
* description: "Storefront guide: How to set the cart's customer."
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The cart's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: |-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. Without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/store/carts/{id}/customer' \
|
||||
* -H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||
* tags:
|
||||
* - Carts
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/StoreCartResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
* $ref: "#/components/responses/unauthorized"
|
||||
* "404":
|
||||
* $ref: "#/components/responses/not_found_error"
|
||||
* "409":
|
||||
* $ref: "#/components/responses/invalid_state_error"
|
||||
* "422":
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: transferCartCustomerWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+70
@@ -0,0 +1,70 @@
|
||||
/**
|
||||
* @oas [post] /store/orders/{id}/transfer/accept
|
||||
* operationId: PostOrdersIdTransferAccept
|
||||
* summary: Accept Order Transfer
|
||||
* x-sidebar-summary: Accept Transfer
|
||||
* description: Accept an order to be transfered to a customer's account, which was specified when the transfer request was created. The transfer is requested previously either by the customer using the
|
||||
* [Request Order Transfer Store API route](https://docs.medusajs.com/api/store#orders_postordersidtransferrequest), or by the admin using the [Request Order Transfer Admin API
|
||||
* route](https://docs.medusajs.com/api/admin#orders_postordersidtransferrequest).
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The order's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: |-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. Without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/StoreAcceptOrderTransfer"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/store/orders/{id}/transfer/accept' \
|
||||
* -H 'x-publishable-api-key: {your_publishable_api_key}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "token": "{value}"
|
||||
* }'
|
||||
* tags:
|
||||
* - Orders
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/StoreOrderResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
* $ref: "#/components/responses/unauthorized"
|
||||
* "404":
|
||||
* $ref: "#/components/responses/not_found_error"
|
||||
* "409":
|
||||
* $ref: "#/components/responses/invalid_state_error"
|
||||
* "422":
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: acceptOrderTransferWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+62
@@ -0,0 +1,62 @@
|
||||
/**
|
||||
* @oas [post] /store/orders/{id}/transfer/cancel
|
||||
* operationId: PostOrdersIdTransferCancel
|
||||
* summary: Cancel Order Transfer
|
||||
* x-sidebar-summary: Cancel Transfer
|
||||
* description: Cancel an order transfer that the logged-in customer previously requested using the [Request Order Transfer](https://docs.medusajs.com/api/store#orders_postordersidtransferrequest) API route.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The order's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: |-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. Without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/store/orders/{id}/transfer/cancel' \
|
||||
* -H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||
* tags:
|
||||
* - Orders
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/StoreOrderResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
* $ref: "#/components/responses/unauthorized"
|
||||
* "404":
|
||||
* $ref: "#/components/responses/not_found_error"
|
||||
* "409":
|
||||
* $ref: "#/components/responses/invalid_state_error"
|
||||
* "422":
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: cancelOrderTransferRequestWorkflow
|
||||
* security:
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
*
|
||||
*/
|
||||
|
||||
+68
@@ -0,0 +1,68 @@
|
||||
/**
|
||||
* @oas [post] /store/orders/{id}/transfer/decline
|
||||
* operationId: PostOrdersIdTransferDecline
|
||||
* summary: Decline Order Transfer
|
||||
* x-sidebar-summary: Decline Transfer
|
||||
* description: Decline an order transfer previously requested, typically by the admin user using the [Request Order Transfer Admin API route](https://docs.medusajs.com/api/admin#orders_postordersidtransferrequest).
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The order's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: |-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. Without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/StoreDeclineOrderTransferRequest"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/store/orders/{id}/transfer/decline' \
|
||||
* -H 'x-publishable-api-key: {your_publishable_api_key}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "token": "{value}"
|
||||
* }'
|
||||
* tags:
|
||||
* - Orders
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/StoreOrderResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
* $ref: "#/components/responses/unauthorized"
|
||||
* "404":
|
||||
* $ref: "#/components/responses/not_found_error"
|
||||
* "409":
|
||||
* $ref: "#/components/responses/invalid_state_error"
|
||||
* "422":
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: declineOrderTransferRequestWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+68
@@ -0,0 +1,68 @@
|
||||
/**
|
||||
* @oas [post] /store/orders/{id}/transfer/request
|
||||
* operationId: PostOrdersIdTransferRequest
|
||||
* summary: Request Order Transfer
|
||||
* x-sidebar-summery: Request Transfer
|
||||
* description: Request an order to be transfered to the logged-in customer's account. The transfer is confirmed using the [Accept Order
|
||||
* Transfer](https://docs.medusajs.com/api/store#orders_postordersidtransferaccept) API route.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The order's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: |-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||
* fields. Without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/StoreRequestOrderTransfer"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/store/orders/{id}/transfer/request' \
|
||||
* -H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||
* tags:
|
||||
* - Orders
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/StoreOrderResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
* $ref: "#/components/responses/unauthorized"
|
||||
* "404":
|
||||
* $ref: "#/components/responses/not_found_error"
|
||||
* "409":
|
||||
* $ref: "#/components/responses/invalid_state_error"
|
||||
* "422":
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: getOrderDetailWorkflow
|
||||
* security:
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
* type: array
|
||||
* description: The products to update.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminUpdateProduct"
|
||||
* $ref: "#/components/schemas/AdminBatchUpdateProduct"
|
||||
* delete:
|
||||
* type: array
|
||||
* description: The products to delete.
|
||||
|
||||
@@ -0,0 +1,162 @@
|
||||
/**
|
||||
* @schema AdminBatchUpdateProduct
|
||||
* type: object
|
||||
* description: The product's details.
|
||||
* x-schemaName: AdminBatchUpdateProduct
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The product's title.
|
||||
* subtitle:
|
||||
* type: string
|
||||
* title: subtitle
|
||||
* description: The product's subtitle.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The product's description.
|
||||
* is_giftcard:
|
||||
* type: boolean
|
||||
* title: is_giftcard
|
||||
* description: Whether the product is a gift card.
|
||||
* discountable:
|
||||
* type: boolean
|
||||
* title: discountable
|
||||
* description: Whether discounts can be applied on the product.
|
||||
* images:
|
||||
* type: array
|
||||
* description: The product's images.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The image's details.
|
||||
* required:
|
||||
* - url
|
||||
* properties:
|
||||
* url:
|
||||
* type: string
|
||||
* title: url
|
||||
* description: The image's URL.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The product's thumbnail URL.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The product's unique handle.
|
||||
* status:
|
||||
* type: string
|
||||
* description: The product's status.
|
||||
* enum:
|
||||
* - draft
|
||||
* - proposed
|
||||
* - published
|
||||
* - rejected
|
||||
* type_id:
|
||||
* type: string
|
||||
* title: type_id
|
||||
* description: The ID of the product's type.
|
||||
* collection_id:
|
||||
* type: string
|
||||
* title: collection_id
|
||||
* description: The ID of the product's collection.
|
||||
* categories:
|
||||
* type: array
|
||||
* description: The product's categories.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The product's category.
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The category's ID.
|
||||
* tags:
|
||||
* type: array
|
||||
* description: The product's tags.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The product's tag.
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The tag's ID.
|
||||
* options:
|
||||
* type: array
|
||||
* description: The product's options.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminUpdateProductOption"
|
||||
* variants:
|
||||
* type: array
|
||||
* description: The product's variants. You can add new variants or update existing ones, passing their IDs in the object.
|
||||
* items:
|
||||
* oneOf:
|
||||
* - $ref: "#/components/schemas/AdminCreateProductVariant"
|
||||
* - $ref: "#/components/schemas/AdminUpdateProductVariant"
|
||||
* sales_channels:
|
||||
* type: array
|
||||
* description: The sales channels that the product is available in.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The sales channel's details.
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The sales channel's ID.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The product's weight.
|
||||
* length:
|
||||
* type: number
|
||||
* title: length
|
||||
* description: The product's length.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The product's height.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The product's width.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The product's HS code.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The product's MID code.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The product's origin country.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The product's material.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product's metadata, can hold custom key-value pairs.
|
||||
* external_id:
|
||||
* type: string
|
||||
* title: external_id
|
||||
* description: The ID of the product in an external or third-party system.
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The product's ID.
|
||||
* required:
|
||||
* - id
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -30,9 +30,14 @@
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The image's metadata, can hold custom key-value pairs.
|
||||
* rank:
|
||||
* type: number
|
||||
* title: rank
|
||||
* description: The image's rank among sibling images.
|
||||
* required:
|
||||
* - id
|
||||
* - url
|
||||
* - rank
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @schema AdminTransferOrder
|
||||
* type: object
|
||||
* description: The details of the request to transfer the order.
|
||||
* x-schemaName: AdminTransferOrder
|
||||
* required:
|
||||
* - customer_id
|
||||
* properties:
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The ID of the customer to transfer the order to.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The description of the order transfer, which can be shown to the customer receiving the order transfer request.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: An internal note viewable only by admin users.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -53,9 +53,63 @@
|
||||
* calculated_price:
|
||||
* type: object
|
||||
* description: The calculated price's details.
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The ID of the price.
|
||||
* price_list_id:
|
||||
* type: string
|
||||
* title: price_list_id
|
||||
* description: The ID of the associated price list.
|
||||
* price_list_type:
|
||||
* type: string
|
||||
* title: price_list_type
|
||||
* description: The price list's type. For example, sale.
|
||||
* min_quantity:
|
||||
* type: number
|
||||
* title: min_quantity
|
||||
* description: The minimum quantity required in the cart for this price to apply.
|
||||
* max_quantity:
|
||||
* type: number
|
||||
* title: max_quantity
|
||||
* description: The maximum quantity allowed in the cart for this price to apply.
|
||||
* required:
|
||||
* - id
|
||||
* - price_list_id
|
||||
* - price_list_type
|
||||
* - min_quantity
|
||||
* - max_quantity
|
||||
* original_price:
|
||||
* type: object
|
||||
* description: The original price's details.
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The ID of the price.
|
||||
* price_list_id:
|
||||
* type: string
|
||||
* title: price_list_id
|
||||
* description: The ID of the associated price list.
|
||||
* price_list_type:
|
||||
* type: string
|
||||
* title: price_list_type
|
||||
* description: The price list's type. For example, sale.
|
||||
* min_quantity:
|
||||
* type: number
|
||||
* title: min_quantity
|
||||
* description: The minimum quantity required in the cart for this price to apply.
|
||||
* max_quantity:
|
||||
* type: number
|
||||
* title: max_quantity
|
||||
* description: The maximum quantity allowed in the cart for this price to apply.
|
||||
* required:
|
||||
* - id
|
||||
* - price_list_id
|
||||
* - price_list_type
|
||||
* - min_quantity
|
||||
* - max_quantity
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -52,7 +52,7 @@
|
||||
* type: object
|
||||
* description: The shipping method's data, useful for fulfillment handling by third-party services.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property
|
||||
* url: https://docs.medusajs.com/resources/commerce-modules/cart/concepts#data-property
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The shipping method's metadata, can hold custom key-value pairs.
|
||||
@@ -77,36 +77,36 @@
|
||||
* title: updated_at
|
||||
* description: The date the shipping method was updated.
|
||||
* original_total:
|
||||
* type: string
|
||||
* type: number
|
||||
* title: original_total
|
||||
* description: The shipping method's total including taxes, excluding promotions.
|
||||
* original_subtotal:
|
||||
* type: string
|
||||
* type: number
|
||||
* title: original_subtotal
|
||||
* description: The shipping method's total excluding taxes, including promotions.
|
||||
* original_tax_total:
|
||||
* type: string
|
||||
* type: number
|
||||
* title: original_tax_total
|
||||
* description: The total taxes applied on the shipping method's amount including promotions.
|
||||
* total:
|
||||
* type: string
|
||||
* type: number
|
||||
* title: total
|
||||
* description: The shipping method's total amount including taxes and promotions.
|
||||
* subtotal:
|
||||
* type: string
|
||||
* type: number
|
||||
* title: subtotal
|
||||
* description: The shipping method's total amount excluding taxes, including promotions.
|
||||
* tax_total:
|
||||
* type: string
|
||||
* type: number
|
||||
* title: tax_total
|
||||
* description: The total taxes applied on the shipping method's amount including promotions.
|
||||
* discount_total:
|
||||
* type: string
|
||||
* type: number
|
||||
* title: discount_total
|
||||
* description: The total amount discounted.
|
||||
* discount_tax_total:
|
||||
* type: string
|
||||
* title: discount_total
|
||||
* type: number
|
||||
* title: discount_tax_total
|
||||
* description: The taxes applied on the discounted amount.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -3,6 +3,14 @@
|
||||
* type: object
|
||||
* description: The adjustment's details.
|
||||
* x-schemaName: BaseLineItemAdjustment
|
||||
* required:
|
||||
* - item
|
||||
* - item_id
|
||||
* - id
|
||||
* - amount
|
||||
* - cart_id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* properties:
|
||||
* item:
|
||||
* $ref: "#/components/schemas/BaseCartLineItem"
|
||||
@@ -48,14 +56,6 @@
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the adjustment was updated.
|
||||
* required:
|
||||
* - item
|
||||
* - item_id
|
||||
* - id
|
||||
* - amount
|
||||
* - cart_id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -3,6 +3,16 @@
|
||||
* type: object
|
||||
* description: The tax line's details
|
||||
* x-schemaName: BaseLineItemTaxLine
|
||||
* required:
|
||||
* - item
|
||||
* - item_id
|
||||
* - total
|
||||
* - subtotal
|
||||
* - id
|
||||
* - code
|
||||
* - rate
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* properties:
|
||||
* item:
|
||||
* $ref: "#/components/schemas/BaseCartLineItem"
|
||||
@@ -52,16 +62,6 @@
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the tax line was updated.
|
||||
* required:
|
||||
* - item
|
||||
* - item_id
|
||||
* - total
|
||||
* - subtotal
|
||||
* - id
|
||||
* - code
|
||||
* - rate
|
||||
* - created_at
|
||||
* - updated_at
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -30,9 +30,14 @@
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The image's metadata, can hold custom key-value pairs.
|
||||
* rank:
|
||||
* type: number
|
||||
* title: rank
|
||||
* description: The image's rank among its sibling images.
|
||||
* required:
|
||||
* - id
|
||||
* - url
|
||||
* - rank
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
/**
|
||||
* @schema StoreAcceptOrderTransfer
|
||||
* type: object
|
||||
* description: The details of accepting the order transfer.
|
||||
* x-schemaName: StoreAcceptOrderTransfer
|
||||
* required:
|
||||
* - token
|
||||
* properties:
|
||||
* token:
|
||||
* type: string
|
||||
* title: token
|
||||
* description: The order transfer's token issued when the transfer was requested.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
/**
|
||||
* @schema StoreDeclineOrderTransferRequest
|
||||
* type: object
|
||||
* description: The details of declining the order transfer request.
|
||||
* x-schemaName: StoreDeclineOrderTransferRequest
|
||||
* required:
|
||||
* - token
|
||||
* properties:
|
||||
* token:
|
||||
* type: string
|
||||
* title: token
|
||||
* description: The order transfer's token issued when the transfer was requested.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -6,6 +6,7 @@
|
||||
* required:
|
||||
* - id
|
||||
* - url
|
||||
* - rank
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
@@ -33,6 +34,10 @@
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The image's metadata, can hold custom key-value pairs.
|
||||
* rank:
|
||||
* type: number
|
||||
* title: rank
|
||||
* description: The image's rank among its sibling images
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema StoreRequestOrderTransfer
|
||||
* type: object
|
||||
* description: The details of requesting the order transfer.
|
||||
* x-schemaName: StoreRequestOrderTransfer
|
||||
* properties:
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The transfer's description, which can be shown to the other customer receiving the request.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -77,6 +77,14 @@ class OasKindGenerator extends FunctionKindGenerator {
|
||||
startsWith: "store/customers",
|
||||
requiresAuthentication: true,
|
||||
},
|
||||
{
|
||||
exact: "store/orders/[id]/transfer/request",
|
||||
requiresAuthentication: true,
|
||||
},
|
||||
{
|
||||
exact: "store/orders/[id]/transfer/cancel",
|
||||
requiresAuthentication: true,
|
||||
},
|
||||
]
|
||||
readonly RESPONSE_TYPE_NAMES = ["MedusaResponse"]
|
||||
readonly FIELD_QUERY_PARAMS = ["fields", "expand"]
|
||||
|
||||
Reference in new issue
Block a user