docs: generate OAS for v2 (#7883)

2024-07-01 15:35:45 +03:00
parent 8fde57263f
commit b9036eca1a
1103 changed files with 125727 additions and 22463 deletions
@@ -0,0 +1,184 @@
+type: object
+description: SUMMARY
+x-schemaName: AdminCreateFulfillment
+required:
+  - location_id
+  - provider_id
+  - delivery_address
+  - items
+  - labels
+  - order
+  - order_id
+  - shipping_option_id
+  - data
+  - packed_at
+  - shipped_at
+  - delivered_at
+  - canceled_at
+  - metadata
+properties:
+  location_id:
+    type: string
+    title: location_id
+    description: The fulfillment's location id.
+  provider_id:
+    type: string
+    title: provider_id
+    description: The fulfillment's provider id.
+  delivery_address:
+    type: object
+    description: The fulfillment's delivery address.
+    required:
+      - first_name
+      - last_name
+      - phone
+      - company
+      - address_1
+      - address_2
+      - city
+      - country_code
+      - province
+      - postal_code
+      - metadata
+    properties:
+      first_name:
+        type: string
+        title: first_name
+        description: The delivery address's first name.
+      last_name:
+        type: string
+        title: last_name
+        description: The delivery address's last name.
+      phone:
+        type: string
+        title: phone
+        description: The delivery address's phone.
+      company:
+        type: string
+        title: company
+        description: The delivery address's company.
+      address_1:
+        type: string
+        title: address_1
+        description: The delivery address's address 1.
+      address_2:
+        type: string
+        title: address_2
+        description: The delivery address's address 2.
+      city:
+        type: string
+        title: city
+        description: The delivery address's city.
+      country_code:
+        type: string
+        title: country_code
+        description: The delivery address's country code.
+      province:
+        type: string
+        title: province
+        description: The delivery address's province.
+      postal_code:
+        type: string
+        title: postal_code
+        description: The delivery address's postal code.
+      metadata:
+        type: object
+        description: The delivery address's metadata.
+  items:
+    type: array
+    description: The fulfillment's items.
+    items:
+      type: object
+      description: The item's items.
+      required:
+        - title
+        - sku
+        - quantity
+        - barcode
+        - line_item_id
+        - inventory_item_id
+      properties:
+        title:
+          type: string
+          title: title
+          description: The item's title.
+        sku:
+          type: string
+          title: sku
+          description: The item's sku.
+        quantity:
+          type: number
+          title: quantity
+          description: The item's quantity.
+        barcode:
+          type: string
+          title: barcode
+          description: The item's barcode.
+        line_item_id:
+          type: string
+          title: line_item_id
+          description: The item's line item id.
+        inventory_item_id:
+          type: string
+          title: inventory_item_id
+          description: The item's inventory item id.
+  labels:
+    type: array
+    description: The fulfillment's labels.
+    items:
+      type: object
+      description: The label's labels.
+      required:
+        - tracking_number
+        - tracking_url
+        - label_url
+      properties:
+        tracking_number:
+          type: string
+          title: tracking_number
+          description: The label's tracking number.
+        tracking_url:
+          type: string
+          title: tracking_url
+          description: The label's tracking url.
+        label_url:
+          type: string
+          title: label_url
+          description: The label's label url.
+  order:
+    type: object
+    description: The fulfillment's order.
+  order_id:
+    type: string
+    title: order_id
+    description: The fulfillment's order id.
+  shipping_option_id:
+    type: string
+    title: shipping_option_id
+    description: The fulfillment's shipping option id.
+  data:
+    type: object
+    description: The fulfillment's data.
+  packed_at:
+    type: string
+    title: packed_at
+    description: The fulfillment's packed at.
+    format: date-time
+  shipped_at:
+    type: string
+    title: shipped_at
+    description: The fulfillment's shipped at.
+    format: date-time
+  delivered_at:
+    type: string
+    title: delivered_at
+    description: The fulfillment's delivered at.
+    format: date-time
+  canceled_at:
+    type: string
+    title: canceled_at
+    description: The fulfillment's canceled at.
+    format: date-time
+  metadata:
+    type: object
+    description: The fulfillment's metadata.