chore(docs): Generated API Reference (#2882)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-12-22 17:09:49 +02:00
parent 233d6904f8
commit 4814045036
477 changed files with 17312 additions and 17713 deletions
@@ -0,0 +1,106 @@
+title: Shipping Option
+description: >-
+  Shipping Options represent a way in which an Order or Return can be shipped.
+  Shipping Options have an associated Fulfillment Provider that will be used
+  when the fulfillment of an Order is initiated. Shipping Options themselves
+  cannot be added to Carts, but serve as a template for Shipping Methods. This
+  distinction makes it possible to customize individual Shipping Methods with
+  additional information.
+type: object
+required:
+  - name
+  - region_id
+  - profile_id
+  - provider_id
+  - price_type
+properties:
+  id:
+    type: string
+    description: The shipping option's ID
+    example: so_01G1G5V27GYX4QXNARRQCW1N8T
+  name:
+    description: >-
+      The name given to the Shipping Option - this may be displayed to the
+      Customer.
+    type: string
+    example: PostFake Standard
+  region_id:
+    type: string
+    description: The region's ID
+    example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
+  region:
+    description: A region object. Available if the relation `region` is expanded.
+    type: object
+  profile_id:
+    description: >-
+      The ID of the Shipping Profile that the shipping option belongs to.
+      Shipping Profiles have a set of defined Shipping Options that can be used
+      to Fulfill a given set of Products.
+    type: string
+    example: sp_01G1G5V239ENSZ5MV4JAR737BM
+  profile:
+    description: Available if the relation `profile` is expanded.
+    $ref: ./ShippingProfile.yaml
+  provider_id:
+    description: >-
+      The id of the Fulfillment Provider, that will be used to process
+      Fulfillments from the Shipping Option.
+    type: string
+    example: manual
+  provider:
+    description: Available if the relation `provider` is expanded.
+    $ref: ./FulfillmentProvider.yaml
+  price_type:
+    description: >-
+      The type of pricing calculation that is used when creatin Shipping Methods
+      from the Shipping Option. Can be `flat_rate` for fixed prices or
+      `calculated` if the Fulfillment Provider can provide price calulations.
+    type: string
+    enum:
+      - flat_rate
+      - calculated
+    example: flat_rate
+  amount:
+    description: >-
+      The amount to charge for shipping when the Shipping Option price type is
+      `flat_rate`.
+    type: integer
+    example: 200
+  is_return:
+    description: Flag to indicate if the Shipping Option can be used for Return shipments.
+    type: boolean
+    default: false
+  requirements:
+    description: >-
+      The requirements that must be satisfied for the Shipping Option to be
+      available for a Cart. Available if the relation `requirements` is
+      expanded.
+    type: array
+    items:
+      $ref: ./ShippingOptionRequirement.yaml
+  data:
+    description: >-
+      The data needed for the Fulfillment Provider to identify the Shipping
+      Option.
+    type: object
+    example: {}
+  includes_tax:
+    description: '[EXPERIMENTAL] Does the shipping option price include tax'
+    type: boolean
+  created_at:
+    type: string
+    description: The date with timezone at which the resource was created.
+    format: date-time
+  updated_at:
+    type: string
+    description: The date with timezone at which the resource was updated.
+    format: date-time
+  deleted_at:
+    type: string
+    description: The date with timezone at which the resource was deleted.
+    format: date-time
+  metadata:
+    type: object
+    description: An optional key-value map with additional details
+    example:
+      car: white