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

oas: [4/n] improve oas schemas (#9064)

Browse Source 
Improve oas schemas [4/n]
This commit is contained in:
Shahed Nasser
2024-09-09 18:52:49 +00:00
committed by GitHub
parent dfb095e2ea
commit abb5f0c2fe
20 changed files with 143 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts
-5
View File
@@ -33,11 +33,6 @@
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* - jwt_token: [] * - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminExportProductRequest"
* x-codeSamples: * x-codeSamples:
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
www/utils/generated/oas-output/schemas/AdminCustomerInGroupFilters.ts
+31 -31
View File
@@ -1,35 +1,35 @@
/** /**
* @schema AdminCustomerInGroupFilters * @schema AdminCustomerInGroupFilters
* type: object * type: object
* description: The customer group's customers. * description: Filters to apply on customers to retrieve their groups.
* x-schemaName: AdminCustomerInGroupFilters * x-schemaName: AdminCustomerInGroupFilters
* properties: * properties:
* id: * id:
* oneOf: * oneOf:
* - type: string * - type: string
* title: id * title: id
* description: The customer's ID. * description: Filter by a customer's ID.
* - type: array * - type: array
* description: The customer's ID. * description: Filter by customer IDs.
* items: * items:
* type: string * type: string
* title: id * title: id
* description: The id's ID. * description: A customer's ID.
* email: * email:
* oneOf: * oneOf:
* - type: string * - type: string
* title: email * title: email
* description: The customer's email. * description: Filter by a customer's email.
* format: email * format: email
* - type: array * - type: array
* description: The customer's email. * description: Filter by customer emails.
* items: * items:
* type: string * type: string
* title: email * title: email
* description: The email's details. * description: A customer's email.
* format: email * format: email
* - type: object * - type: object
* description: The customer's email. * description: Apply filters on the customer's email.
* properties: * properties:
* $and: * $and:
* type: array * type: array
@@ -49,7 +49,7 @@
* title: $eq * title: $eq
* description: Filter by an exact match. * description: Filter by an exact match.
* - type: array * - type: array
* description: Filter by an exact match. * description: Filter by exact matches
* items: * items:
* type: string * type: string
* title: $eq * title: $eq
@@ -146,71 +146,71 @@
* oneOf: * oneOf:
* - type: string * - type: string
* title: default_billing_address_id * title: default_billing_address_id
* description: The customer's default billing address id. * description: Filter by the ID of a customer's default billing address.
* - type: array * - type: array
* description: The customer's default billing address id. * description: Filter by the IDs of a customers' default billing address.
* items: * items:
* type: string * type: string
* title: default_billing_address_id * title: default_billing_address_id
* description: The default billing address id's details. * description: The ID of a customer's default billing address.
* default_shipping_address_id: * default_shipping_address_id:
* oneOf: * oneOf:
* - type: string * - type: string
* title: default_shipping_address_id * title: default_shipping_address_id
* description: The customer's default shipping address id. * description: Filter by the ID of a customer's default shipping address.
* - type: array * - type: array
* description: The customer's default shipping address id. * description: Filter by the IDs of a customers' default shipping address.
* items: * items:
* type: string * type: string
* title: default_shipping_address_id * title: default_shipping_address_id
* description: The default shipping address id's details. * description: The ID of a customer's default shipping address.
* company_name: * company_name:
* oneOf: * oneOf:
* - type: string * - type: string
* title: company_name * title: company_name
* description: The customer's company name. * description: Filter by a customer's company name.
* - type: array * - type: array
* description: The customer's company name. * description: Filter by customers' company names.
* items: * items:
* type: string * type: string
* title: company_name * title: company_name
* description: The company name's details. * description: A company name.
* first_name: * first_name:
* oneOf: * oneOf:
* - type: string * - type: string
* title: first_name * title: first_name
* description: The customer's first name. * description: Filter by a customer's first name.
* - type: array * - type: array
* description: The customer's first name. * description: Filter by customers' first names.
* items: * items:
* type: string * type: string
* title: first_name * title: first_name
* description: The first name's details. * description: A first name.
* last_name: * last_name:
* oneOf: * oneOf:
* - type: string * - type: string
* title: last_name * title: last_name
* description: The customer's last name. * description: Filter by a customer's last name.
* - type: array * - type: array
* description: The customer's last name. * description: Filter by customers' last names.
* items: * items:
* type: string * type: string
* title: last_name * title: last_name
* description: The last name's details. * description: A last name.
* created_by: * created_by:
* oneOf: * oneOf:
* - type: string * - type: string
* title: created_by * title: created_by
* description: The customer's created by. * description: Filter by the ID of a user to retrieve the groups of the customers they created.
* - type: array * - type: array
* description: The customer's created by. * description: Filter by the ID of users to retrieve the groups of the customers they created.
* items: * items:
* type: string * type: string
* title: created_by * title: created_by
* description: The created by's details. * description: A user's ID.
* created_at: * created_at:
* type: object * type: object
* description: The customer's created at. * description: Filter the customer's creation date.
* properties: * properties:
* $and: * $and:
* type: array * type: array
@@ -230,7 +230,7 @@
* title: $eq * title: $eq
* description: Filter by an exact match. * description: Filter by an exact match.
* - type: array * - type: array
* description: Filter by an exact match. * description: Filter by exact matches
* items: * items:
* type: string * type: string
* title: $eq * title: $eq
@@ -325,7 +325,7 @@
* description: Filter by whether a value for this parameter exists (not `null`). * description: Filter by whether a value for this parameter exists (not `null`).
* updated_at: * updated_at:
* type: object * type: object
* description: The customer's updated at. * description: Filter the customer's update date.
* properties: * properties:
* $and: * $and:
* type: array * type: array
@@ -440,7 +440,7 @@
* description: Filter by whether a value for this parameter exists (not `null`). * description: Filter by whether a value for this parameter exists (not `null`).
* deleted_at: * deleted_at:
* type: object * type: object
* description: The customer's deleted at. * description: Filter the customer's deletion date.
* properties: * properties:
* $and: * $and:
* type: array * type: array
www/utils/generated/oas-output/schemas/AdminDeletePaymentCollectionResponse.ts
+3 -3
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminDeletePaymentCollectionResponse * @schema AdminDeletePaymentCollectionResponse
* type: object * type: object
* description: SUMMARY * description: The result of deleting the payment collection.
* x-schemaName: AdminDeletePaymentCollectionResponse * x-schemaName: AdminDeletePaymentCollectionResponse
* required: * required:
* - id * - id
@@ -15,12 +15,12 @@
* object: * object:
* type: string * type: string
* title: object * title: object
* description: SUMMARY * description: The name of the object that was deleted.
* default: payment-collection * default: payment-collection
* deleted: * deleted:
* type: boolean * type: boolean
* title: deleted * title: deleted
* description: SUMMARY * description: Whether the object was deleted.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminDraftOrderResponse.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminDraftOrderResponse * @schema AdminDraftOrderResponse
* type: object * type: object
* description: SUMMARY * description: The draft order's details.
* x-schemaName: AdminDraftOrderResponse * x-schemaName: AdminDraftOrderResponse
* required: * required:
* - draft_order * - draft_order
www/utils/generated/oas-output/schemas/AdminExchange.ts
+41 -35
View File
@@ -46,31 +46,32 @@
* order_id: * order_id:
* type: string * type: string
* title: order_id * title: order_id
* description: The exchange's order id. * description: The ID of the order the exchange is created for.
* return_items: * return_items:
* type: array * type: array
* description: The exchange's return items. * description: The items returned (inbound) by the exchange.
* items: * items:
* $ref: "#/components/schemas/AdminReturnItem" * $ref: "#/components/schemas/AdminReturnItem"
* additional_items: * additional_items:
* type: array * type: array
* description: The exchange's additional items. * description: The new items (outbound) sent by the exchange.
* items: * items:
* $ref: "#/components/schemas/BaseExchangeItem" * $ref: "#/components/schemas/BaseExchangeItem"
* no_notification: * no_notification:
* type: boolean * type: boolean
* title: no_notification * title: no_notification
* description: The exchange's no notification. * description: Whether to send the customer notifications when the exchange is updated.
* difference_due: * difference_due:
* type: number * type: number
* title: difference_due * title: difference_due
* description: The exchange's difference due. * description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
* return: * return:
* description: the return associated with the exchange.
* $ref: "#/components/schemas/AdminReturn" * $ref: "#/components/schemas/AdminReturn"
* return_id: * return_id:
* type: string * type: string
* title: return_id * title: return_id
* description: The exchange's return id. * description: The ID of the associated exchange.
* currency_code: * currency_code:
* type: string * type: string
* title: currency_code * title: currency_code
@@ -82,31 +83,33 @@
* region_id: * region_id:
* type: string * type: string
* title: region_id * title: region_id
* description: The exchange's region id. * description: The ID of the associated order's region.
* customer_id: * customer_id:
* type: string * type: string
* title: customer_id * title: customer_id
* description: The exchange's customer id. * description: The ID of the customer that placed the order.
* sales_channel_id: * sales_channel_id:
* type: string * type: string
* title: sales_channel_id * title: sales_channel_id
* description: The exchange's sales channel id. * description: The ID of the sales channel the associated order belongs to.
* email: * email:
* type: string * type: string
* title: email * title: email
* description: The exchange's email. * description: The email used when placing the order.
* format: email * format: email
* display_id: * display_id:
* type: number * type: number
* title: display_id * title: display_id
* description: The exchange's display id. * description: The exchange's display ID.
* shipping_address: * shipping_address:
* description: The shipping address to send new items to.
* $ref: "#/components/schemas/BaseOrderAddress" * $ref: "#/components/schemas/BaseOrderAddress"
* billing_address: * billing_address:
* description: The customer's billing address.
* $ref: "#/components/schemas/BaseOrderAddress" * $ref: "#/components/schemas/BaseOrderAddress"
* shipping_methods: * shipping_methods:
* type: array * type: array
* description: The exchange's shipping methods. * description: The shipping methods used to send the new (outbound) items.
* items: * items:
* $ref: "#/components/schemas/BaseOrderShippingMethod" * $ref: "#/components/schemas/BaseOrderShippingMethod"
* payment_collections: * payment_collections:
@@ -130,7 +133,7 @@
* - requires_action * - requires_action
* fulfillments: * fulfillments:
* type: array * type: array
* description: The exchange's fulfillments. * description: The exchange's fulfillments of new (outbound) items.
* items: * items:
* $ref: "#/components/schemas/BaseOrderFulfillment" * $ref: "#/components/schemas/BaseOrderFulfillment"
* fulfillment_status: * fulfillment_status:
@@ -148,87 +151,90 @@
* transactions: * transactions:
* type: array * type: array
* description: The exchange's transactions. * description: The exchange's transactions.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
* items: * items:
* $ref: "#/components/schemas/BaseOrderTransaction" * $ref: "#/components/schemas/BaseOrderTransaction"
* summary: * summary:
* description: The totals summary of the exchange.
* $ref: "#/components/schemas/BaseOrderSummary" * $ref: "#/components/schemas/BaseOrderSummary"
* metadata: * metadata:
* type: object * type: object
* description: The exchange's metadata. * description: The exchange's metadata, can hold custom key-value pairs.
* created_at: * created_at:
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The exchange's created at. * description: The date that the exchange was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The exchange's updated at. * description: The date that the exchange was updated.
* original_item_total: * original_item_total:
* type: number * type: number
* title: original_item_total * title: original_item_total
* description: The exchange's original item total. * description: The total of the original items in the order.
* original_item_subtotal: * original_item_subtotal:
* type: number * type: number
* title: original_item_subtotal * title: original_item_subtotal
* description: The exchange's original item subtotal. * description: The subtotal of the original items in the order.
* original_item_tax_total: * original_item_tax_total:
* type: number * type: number
* title: original_item_tax_total * title: original_item_tax_total
* description: The exchange's original item tax total. * description: The total tax of the original items in the order.
* item_total: * item_total:
* type: number * type: number
* title: item_total * title: item_total
* description: The exchange's item total. * description: The total of the exchange's new items.
* item_subtotal: * item_subtotal:
* type: number * type: number
* title: item_subtotal * title: item_subtotal
* description: The exchange's item subtotal. * description: The subtotal of the exchange's new items.
* item_tax_total: * item_tax_total:
* type: number * type: number
* title: item_tax_total * title: item_tax_total
* description: The exchange's item tax total. * description: The tax total of the exchange's new items.
* original_total: * original_total:
* type: number * type: number
* title: original_total * title: original_total
* description: The exchange's original total. * description: The total of the order.
* original_subtotal: * original_subtotal:
* type: number * type: number
* title: original_subtotal * title: original_subtotal
* description: The exchange's original subtotal. * description: The subtotal of the order.
* original_tax_total: * original_tax_total:
* type: number * type: number
* title: original_tax_total * title: original_tax_total
* description: The exchange's original tax total. * description: The tax total of the order.
* total: * total:
* type: number * type: number
* title: total * title: total
* description: The exchange's total. * description: The total of the exchange.
* subtotal: * subtotal:
* type: number * type: number
* title: subtotal * title: subtotal
* description: The exchange's subtotal. * description: The subtotal of the exchange.
* tax_total: * tax_total:
* type: number * type: number
* title: tax_total * title: tax_total
* description: The exchange's tax total. * description: The tax total of the exchange.
* discount_total: * discount_total:
* type: number * type: number
* title: discount_total * title: discount_total
* description: The exchange's discount total. * description: The discount total of the exchange.
* discount_tax_total: * discount_tax_total:
* type: number * type: number
* title: discount_tax_total * title: discount_tax_total
* description: The exchange's discount tax total. * description: The total taxes on discount of the exchange.
* gift_card_total: * gift_card_total:
* type: number * type: number
* title: gift_card_total * title: gift_card_total
* description: The exchange's gift card total. * description: The gift cards total of the exchange.
* gift_card_tax_total: * gift_card_tax_total:
* type: number * type: number
* title: gift_card_tax_total * title: gift_card_tax_total
* description: The exchange's gift card tax total. * description: The total taxes on the gift card of the exchange.
* shipping_total: * shipping_total:
* type: number * type: number
* title: shipping_total * title: shipping_total
@@ -244,15 +250,15 @@
* original_shipping_total: * original_shipping_total:
* type: number * type: number
* title: original_shipping_total * title: original_shipping_total
* description: The exchange's original shipping total. * description: The order's shipping total.
* original_shipping_subtotal: * original_shipping_subtotal:
* type: number * type: number
* title: original_shipping_subtotal * title: original_shipping_subtotal
* description: The exchange's original shipping subtotal. * description: The order's shipping subtotal.
* original_shipping_tax_total: * original_shipping_tax_total:
* type: number * type: number
* title: original_shipping_tax_total * title: original_shipping_tax_total
* description: The exchange's original shipping tax total. * description: The order's shipping tax total.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminExchangeDeleteResponse.ts
+2 -2
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminExchangeDeleteResponse * @schema AdminExchangeDeleteResponse
* type: object * type: object
* description: SUMMARY * description: The details of deleting an exchange.
* x-schemaName: AdminExchangeDeleteResponse * x-schemaName: AdminExchangeDeleteResponse
* required: * required:
* - id * - id
@@ -20,7 +20,7 @@
* deleted: * deleted:
* type: boolean * type: boolean
* title: deleted * title: deleted
* description: Whether the Exchange was deleted. * description: Whether the exchange was deleted.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts
+2 -1
View File
@@ -1,13 +1,14 @@
/** /**
* @schema AdminExchangeOrderResponse * @schema AdminExchangeOrderResponse
* type: object * type: object
* description: SUMMARY * description: The exchange's details.
* x-schemaName: AdminExchangeOrderResponse * x-schemaName: AdminExchangeOrderResponse
* required: * required:
* - order * - order
* - exchange * - exchange
* properties: * properties:
* order: * order:
* description: The details of the associated order.
* $ref: "#/components/schemas/Order" * $ref: "#/components/schemas/Order"
* exchange: * exchange:
* $ref: "#/components/schemas/AdminExchange" * $ref: "#/components/schemas/AdminExchange"
www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminExchangePreviewResponse * @schema AdminExchangePreviewResponse
* type: object * type: object
* description: SUMMARY * description: A preview of the order once the exchange is applied.
* x-schemaName: AdminExchangePreviewResponse * x-schemaName: AdminExchangePreviewResponse
* required: * required:
* - order_preview * - order_preview
www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts
+3 -1
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminExchangeRequestResponse * @schema AdminExchangeRequestResponse
* type: object * type: object
* description: SUMMARY * description: The details of a requested exchange.
* x-schemaName: AdminExchangeRequestResponse * x-schemaName: AdminExchangeRequestResponse
* required: * required:
* - return * - return
@@ -9,8 +9,10 @@
* - exchange * - exchange
* properties: * properties:
* return: * return:
* description: The associated return's details.
* $ref: "#/components/schemas/AdminReturn" * $ref: "#/components/schemas/AdminReturn"
* order_preview: * order_preview:
* description: A preview of the order once the exchange is applied.
* $ref: "#/components/schemas/OrderPreview" * $ref: "#/components/schemas/OrderPreview"
* exchange: * exchange:
* $ref: "#/components/schemas/AdminExchange" * $ref: "#/components/schemas/AdminExchange"
www/utils/generated/oas-output/schemas/AdminExchangeResponse.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminExchangeResponse * @schema AdminExchangeResponse
* type: object * type: object
* description: SUMMARY * description: The exchange's details.
* x-schemaName: AdminExchangeResponse * x-schemaName: AdminExchangeResponse
* required: * required:
* - exchange * - exchange
www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminExchangeReturnResponse * @schema AdminExchangeReturnResponse
* type: object * type: object
* description: SUMMARY * description: The details of an exchange's return.
* x-schemaName: AdminExchangeReturnResponse * x-schemaName: AdminExchangeReturnResponse
* required: * required:
* - order_preview * - order_preview
www/utils/generated/oas-output/schemas/AdminExportProductRequest.ts
-8
View File
@@ -1,8 +0,0 @@
/**
* @schema AdminExportProductRequest
* type: object
* description: SUMMARY
* x-schemaName: AdminExportProductRequest
*
*/
www/utils/generated/oas-output/schemas/AdminExportProductResponse.ts
+2 -2
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminExportProductResponse * @schema AdminExportProductResponse
* type: object * type: object
* description: SUMMARY * description: The details of the product export.
* x-schemaName: AdminExportProductResponse * x-schemaName: AdminExportProductResponse
* required: * required:
* - transaction_id * - transaction_id
@@ -9,7 +9,7 @@
* transaction_id: * transaction_id:
* type: string * type: string
* title: transaction_id * title: transaction_id
* description: The product's transaction id. * description: The ID of the workflow execution's transaction. Use it to check the status of the export by sending a GET request to `/admin/workflows-executions/export-products/:transaction-id`
* *
*/ */
www/utils/generated/oas-output/schemas/AdminFile.ts
+2 -2
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminFile * @schema AdminFile
* type: object * type: object
* description: The upload's file. * description: A file's details.
* x-schemaName: AdminFile * x-schemaName: AdminFile
* required: * required:
* - id * - id
@@ -14,7 +14,7 @@
* url: * url:
* type: string * type: string
* title: url * title: url
* description: The file's url. * description: The file's URL.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminFileListResponse.ts
+2 -2
View File
@@ -1,14 +1,14 @@
/** /**
* @schema AdminFileListResponse * @schema AdminFileListResponse
* type: object * type: object
* description: SUMMARY * description: The list of uploaded files.
* x-schemaName: AdminFileListResponse * x-schemaName: AdminFileListResponse
* required: * required:
* - files * - files
* properties: * properties:
* files: * files:
* type: array * type: array
* description: The upload's files. * description: The list of uploaded files.
* items: * items:
* $ref: "#/components/schemas/AdminFile" * $ref: "#/components/schemas/AdminFile"
* *
www/utils/generated/oas-output/schemas/AdminFileResponse.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminFileResponse * @schema AdminFileResponse
* type: object * type: object
* description: SUMMARY * description: A file's details.
* x-schemaName: AdminFileResponse * x-schemaName: AdminFileResponse
* required: * required:
* - file * - file
www/utils/generated/oas-output/schemas/AdminFulfillment.ts
+17 -13
View File
@@ -29,18 +29,20 @@
* location_id: * location_id:
* type: string * type: string
* title: location_id * title: location_id
* description: The fulfillment's location id. * description: The ID of the location the fulfillment's items are shipped from.
* provider_id: * provider_id:
* type: string * type: string
* title: provider_id * title: provider_id
* description: The fulfillment's provider id. * description: The ID of the fulfillment provider handling this fulfillment.
* shipping_option_id: * shipping_option_id:
* type: string * type: string
* title: shipping_option_id * title: shipping_option_id
* description: The fulfillment's shipping option id. * description: The ID of the shipping option this fulfillment is created for.
* provider: * provider:
* description: The details of the fulfillment provider using to handle this fulfillment.
* $ref: "#/components/schemas/AdminFulfillmentProvider" * $ref: "#/components/schemas/AdminFulfillmentProvider"
* delivery_address: * delivery_address:
* description: The address to deliver the item to.
* $ref: "#/components/schemas/AdminFulfillmentAddress" * $ref: "#/components/schemas/AdminFulfillmentAddress"
* items: * items:
* type: array * type: array
@@ -49,46 +51,48 @@
* $ref: "#/components/schemas/AdminFulfillmentItem" * $ref: "#/components/schemas/AdminFulfillmentItem"
* labels: * labels:
* type: array * type: array
* description: The fulfillment's labels. * description: The fulfillment's shipment labels.
* items: * items:
* $ref: "#/components/schemas/AdminFulfillmentLabel" * $ref: "#/components/schemas/AdminFulfillmentLabel"
* packed_at: * packed_at:
* type: string * type: string
* title: packed_at * title: packed_at
* description: The fulfillment's packed at. * description: The date the fulfillment was packed at.
* shipped_at: * shipped_at:
* type: string * type: string
* title: shipped_at * title: shipped_at
* description: The fulfillment's shipped at. * description: The date the fulfillment was shipped at.
* delivered_at: * delivered_at:
* type: string * type: string
* title: delivered_at * title: delivered_at
* description: The fulfillment's delivered at. * description: The date the fulfillment was delivered at.
* canceled_at: * canceled_at:
* type: string * type: string
* title: canceled_at * title: canceled_at
* description: The fulfillment's canceled at. * description: The date the fulfillment was canceled at.
* data: * data:
* type: object * type: object
* description: The fulfillment's data. * description: The fulfillment's data, useful for the third-party provider handling the fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* metadata: * metadata:
* type: object * type: object
* description: The fulfillment's metadata. * description: The fulfillment's metadata, can hold custom key-value pairs.
* created_at: * created_at:
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The fulfillment's created at. * description: The date the fulfillment was created at.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The fulfillment's updated at. * description: The date the fulfillment was updated at.
* deleted_at: * deleted_at:
* type: string * type: string
* format: date-time * format: date-time
* title: deleted_at * title: deleted_at
* description: The fulfillment's deleted at. * description: The date the fulfillment was deleted at.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminFulfillmentAddress.ts
+17 -17
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminFulfillmentAddress * @schema AdminFulfillmentAddress
* type: object * type: object
* description: The fulfillment's delivery address. * description: An address's details.
* x-schemaName: AdminFulfillmentAddress * x-schemaName: AdminFulfillmentAddress
* required: * required:
* - id * - id
@@ -24,69 +24,69 @@
* id: * id:
* type: string * type: string
* title: id * title: id
* description: The delivery address's ID. * description: The address's ID.
* fulfillment_id: * fulfillment_id:
* type: string * type: string
* title: fulfillment_id * title: fulfillment_id
* description: The delivery address's fulfillment id. * description: The ID of the fulfillment that the address belongs to.
* company: * company:
* type: string * type: string
* title: company * title: company
* description: The delivery address's company. * description: The address's company.
* first_name: * first_name:
* type: string * type: string
* title: first_name * title: first_name
* description: The delivery address's first name. * description: The address's first name.
* last_name: * last_name:
* type: string * type: string
* title: last_name * title: last_name
* description: The delivery address's last name. * description: The address's last name.
* address_1: * address_1:
* type: string * type: string
* title: address_1 * title: address_1
* description: The delivery address's address 1. * description: The address's first line.
* address_2: * address_2:
* type: string * type: string
* title: address_2 * title: address_2
* description: The delivery address's address 2. * description: The address's second line.
* city: * city:
* type: string * type: string
* title: city * title: city
* description: The delivery address's city. * description: The address's city.
* country_code: * country_code:
* type: string * type: string
* title: country_code * title: country_code
* description: The delivery address's country code. * description: The address's country code.
* province: * province:
* type: string * type: string
* title: province * title: province
* description: The delivery address's province. * description: The address's province.
* postal_code: * postal_code:
* type: string * type: string
* title: postal_code * title: postal_code
* description: The delivery address's postal code. * description: The address's postal code.
* phone: * phone:
* type: string * type: string
* title: phone * title: phone
* description: The delivery address's phone. * description: The address's phone.
* metadata: * metadata:
* type: object * type: object
* description: The delivery address's metadata. * description: The address's metadata, can hold custom key-value pairs.
* created_at: * created_at:
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The delivery address's created at. * description: The date the address was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The delivery address's updated at. * description: The date the address was updated.
* deleted_at: * deleted_at:
* type: string * type: string
* format: date-time * format: date-time
* title: deleted_at * title: deleted_at
* description: The delivery address's deleted at. * description: The date the address was deleted.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminFulfillmentItem.ts
+9 -9
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminFulfillmentItem * @schema AdminFulfillmentItem
* type: object * type: object
* description: The item's items. * description: The details of a fulfillment's item.
* x-schemaName: AdminFulfillmentItem * x-schemaName: AdminFulfillmentItem
* required: * required:
* - id * - id
@@ -27,11 +27,11 @@
* quantity: * quantity:
* type: number * type: number
* title: quantity * title: quantity
* description: The item's quantity. * description: The item's quantity to be fulfilled.
* sku: * sku:
* type: string * type: string
* title: sku * title: sku
* description: The item's sku. * description: The item's SKU.
* barcode: * barcode:
* type: string * type: string
* title: barcode * title: barcode
@@ -39,30 +39,30 @@
* line_item_id: * line_item_id:
* type: string * type: string
* title: line_item_id * title: line_item_id
* description: The item's line item id. * description: The ID of the order's line item to be fulfilled.
* inventory_item_id: * inventory_item_id:
* type: string * type: string
* title: inventory_item_id * title: inventory_item_id
* description: The item's inventory item id. * description: The ID of the inventory item of the underlying product variant.
* fulfillment_id: * fulfillment_id:
* type: string * type: string
* title: fulfillment_id * title: fulfillment_id
* description: The item's fulfillment id. * description: The ID of the fulfillment the item belongs to.
* created_at: * created_at:
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The item's created at. * description: The date the item was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The item's updated at. * description: The date the item was updated.
* deleted_at: * deleted_at:
* type: string * type: string
* format: date-time * format: date-time
* title: deleted_at * title: deleted_at
* description: The item's deleted at. * description: The date the item was deleted.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminFulfillmentLabel.ts
+7 -7
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminFulfillmentLabel * @schema AdminFulfillmentLabel
* type: object * type: object
* description: The label's labels. * description: The details of a fulfillmet's shipment label.
* x-schemaName: AdminFulfillmentLabel * x-schemaName: AdminFulfillmentLabel
* required: * required:
* - id * - id
@@ -24,30 +24,30 @@
* tracking_url: * tracking_url:
* type: string * type: string
* title: tracking_url * title: tracking_url
* description: The label's tracking url. * description: The label's tracking URL.
* label_url: * label_url:
* type: string * type: string
* title: label_url * title: label_url
* description: The label's label url. * description: The label's URL.
* fulfillment_id: * fulfillment_id:
* type: string * type: string
* title: fulfillment_id * title: fulfillment_id
* description: The label's fulfillment id. * description: The ID of the fulfillment the label is associated with.
* created_at: * created_at:
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The label's created at. * description: The date the label was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The label's updated at. * description: The date the label was updated.
* deleted_at: * deleted_at:
* type: string * type: string
* format: date-time * format: date-time
* title: deleted_at * title: deleted_at
* description: The label's deleted at. * description: The date the label was deleted.
* *
*/ */