@redotech/redo-api-schema 2.2.36

package/lib/openapi.yaml

@@ -0,0 +1,1178 @@
+components:
+  headers:
+    page-next.header:
+      description: Next value for X-Page-Continue, for more results
+      schema:
+        type: string
+  parameters:
+    page-continue.param:
+      description: Page marker, from X-Page-Next header
+      example: 64df700931a04885276c3364
+      in: header
+      name: X-Page-Continue
+      schema:
+        type: string
+    page-size.param:
+      description: Page size, defaults to 20
+      example: 20
+      in: header
+      name: X-Page-Size
+      schema:
+        type: integer
+    return-id.param:
+      description: Return ID
+      in: path
+      name: returnId
+      required: true
+      schema:
+        example: 64e4d5e837572a4813b73e40
+        type: string
+    store-id.param:
+      description: Store ID
+      in: path
+      name: storeId
+      required: true
+      schema:
+        example: 64e5a8a1af49a89df37e4ee7
+        type: string
+    updated-at-max.param:
+      description: Maximum updated time, exclusive
+      example: '2000-02-01T00:00:00Z'
+      in: query
+      name: updated_at_max
+      schema:
+        format: date-time
+        type: string
+    updated-at-min.param:
+      description: Minimum updated time, inclusive
+      example: '2000-01-01T00:00:00Z'
+      in: query
+      name: updated_at_min
+      schema:
+        format: date-time
+        type: string
+    webhook-id.param:
+      description: Webhook ID
+      in: path
+      name: webhookId
+      required: true
+      schema:
+        example: 64e5a865a58eefeed7f05ea6
+        type: string
+  schemas:
+    address.schema:
+      description: Address.
+      properties:
+        city:
+          description: City name
+          examples:
+            - Anytown
+          title: City
+          type: string
+        country:
+          description: Country code
+          examples:
+            - US
+            - CA
+          title: Country
+          type: string
+        line1:
+          description: Line 1
+          examples:
+            - 123 Main St
+          title: Line 1
+          type: string
+        line2:
+          default: ''
+          description: Line 2
+          examples:
+            - ''
+          title: Line 2
+          type: string
+        postalCode:
+          description: Postal or ZIP code
+          examples:
+            - '12345'
+          title: Postal code
+          type: string
+        state:
+          description: State or province
+          examples:
+            - WA
+            - Washington
+          title: State
+          type: string
+      required:
+        - city
+        - country
+        - line1
+        - state
+        - postalCode
+      title: Address
+      type: object
+    comment.schema:
+      description: Comment with either message or image.
+      examples:
+        - message: Item is worn.
+        - image: eJxiYAEAAAD//wMAAAYABQ==
+      oneOf:
+        - properties:
+            image:
+              contentEncoding: base64
+              description: Base64-encoded image
+              title: Image
+              type: string
+          title: Image comment
+          type: object
+        - properties:
+            message:
+              description: Message.
+              title: Message
+              type: string
+          title: Message comment
+          type: object
+      title: Comment
+    error.schema:
+      description: See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
+      properties:
+        detail:
+          description: A human-readable explanation specific to this occurrence of the problem.
+          type: string
+        instance:
+          description: A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+          type: string
+        status:
+          description: The HTTP status code ([[RFC7231], Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6)) generated by the origin server for this occurrence of the problem.
+          type: number
+        title:
+          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [[RFC7231], Section 3.4](https://datatracker.ietf.org/doc/html/rfc7231#section-3.4)).
+          type: string
+        type:
+          default: about:blank
+          description: A URI reference [[RFC3986](https://datatracker.ietf.org/doc/html/rfc3986)] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [[W3C.REC-html5-20141028](https://datatracker.ietf.org/doc/html/rfc7807#ref-W3C.REC-html5-20141028)]).  When this member is not present, its value is assumed to be "about:blank".
+          format: uri-reference
+          type: string
+      title: Problem details
+      type: object
+    exchange-provision.schema:
+      enum:
+        - instant
+        - deferred
+      example: deferred
+      title: Exchang provision
+      type: string
+    https-callback.schema:
+      description: HTTPS callback
+      properties:
+        auth:
+          description: Authorization.
+          oneOf:
+            - properties:
+                bearer:
+                  description: Bearer
+                  properties:
+                    token:
+                      description: Token for Bearer authorization.
+                      example: abc123
+                      format: password
+                      title: Token
+                      type: string
+                  title: Bearer
+              title: Bearer authorization
+              type: object
+            - type: 'null'
+          title: Authorization
+        url:
+          description: HTTPS callback URL.
+          example: https://subscriber.example.org/events
+          format: uri
+          pattern: ^https://
+          title: URL
+          type: string
+      required:
+        - auth
+        - url
+      title: HTTPS callback
+      type: object
+    item-quantity.schema:
+      description: Item quantity.
+      example: 1
+      exclusiveMinimum: 0
+      title: Item quantity
+      type: number
+    money.schema:
+      description: Currency amount
+      properties:
+        amount:
+          examples:
+            - 50.2
+            - 1.78
+          title: Amount
+          type: number
+        currency:
+          examples:
+            - USD
+            - EUR
+          title: Currency
+          type: string
+      title: Money
+      type: object
+    order-read.schema:
+      description: Order.
+      properties:
+        customer:
+          properties:
+            emailAddress:
+              description: Email address of customer.
+              format: email
+              title: Email address
+              type: string
+            name:
+              $ref: '#/components/schemas/person-name.schema'
+              description: Name of customer.
+              title: Name
+            phoneNumber:
+              $ref: '#/components/schemas/phone-number.schema'
+              description: Phone number of customer.
+              title: Phone number
+          required:
+            - name
+          type: object
+        externalId:
+          description: Shopify ID
+          examples:
+            - '1073459971'
+            - '450789469'
+          title: External ID
+          type: string
+        id:
+          description: Order ID
+          example: 64e4da943dd822979a70bd12
+          title: ID
+          type: string
+        items:
+          items:
+            properties:
+              externalId:
+                example: '123'
+                type: string
+              id:
+                description: Line item ID
+                title: ID
+                type: string
+              product:
+                $ref: '#/components/schemas/product.schema'
+                title: Product
+              quantity:
+                $ref: '#/components/schemas/item-quantity.schema'
+                title: Quantity
+              variant:
+                $ref: '#/components/schemas/product-variant.schema'
+                title: Variant
+            required:
+              - id
+              - product
+              - quantity
+              - variant
+          title: Line items
+          type: array
+        name:
+          description: Shopify name.
+          examples:
+            - '#123'
+          title: Name
+          type: string
+      required:
+        - customer
+        - id
+        - items
+        - name
+      title: Order
+      type: object
+    person-name.schema:
+      description: Person name.
+      properties:
+        given:
+          description: Given name
+          examples:
+            - John
+            - Mary
+          type: string
+        surname:
+          description: Surname
+          examples:
+            - Smith
+            - Brown
+          type: string
+      required:
+        - given
+        - surname
+      title: Person name
+      type: object
+    phone-number.schema:
+      description: Phone number, in E.164 format
+      examples:
+        - '+15555555555'
+      title: Phone number
+      type: string
+    product-variant.schema:
+      properties:
+        externalId:
+          title: External ID
+          type: string
+        name:
+          title: Title
+          type: string
+        sku:
+          title: SKU
+          type: string
+        weight:
+          $ref: '#/components/schemas/weight.schema'
+          title: Weight
+      required:
+        - name
+      title: Product variant
+      type: object
+    product.schema:
+      description: Product.
+      properties:
+        externalId:
+          description: Product ID in external system (e.g. shopify).
+          title: External ID
+          type: string
+        name:
+          description: Product title
+          title: Name
+          type: string
+      required:
+        - name
+      title: Product
+      type: object
+    return-read.schema:
+      description: Return read.
+      properties:
+        createdAt:
+          description: Time of creation.
+          format: date-time
+          title: Created at
+          type: string
+        destination:
+          properties:
+            mailingAddress:
+              $ref: '#/components/schemas/address.schema'
+              description: Mailing address to send the returned items.
+              title: Mailing address
+            phoneNumber:
+              $ref: '#/components/schemas/phone-number.schema'
+              description: Phone number of the destination.
+              title: Phone number
+          type: object
+        exchange:
+          description: Exchange order
+          properties:
+            items:
+              items:
+                properties:
+                  id:
+                    title: ID
+                    type: string
+                  product:
+                    $ref: '#/components/schemas/product.schema'
+                    title: Product
+                  quantity:
+                    $ref: '#/components/schemas/item-quantity.schema'
+                    title: Quantity
+                  variant:
+                    $ref: '#/components/schemas/product-variant.schema'
+                required:
+                  - id
+                  - quantity
+                  - product
+                  - variant
+              title: Line items
+              type: array
+            order:
+              properties:
+                externalId:
+                  description: ID of external order
+                  title: External ID
+                  type: string
+                id:
+                  type: string
+              type: object
+            provision:
+              $ref: '#/components/schemas/exchange-provision.schema'
+              title: Provision
+          required:
+            - items
+            - provision
+          title: Exchange
+          type: object
+        id:
+          description: Return identifier.
+          examples:
+            - 64df65d4c5a4ca3eff4b4e43
+          title: Identifier
+          type: string
+        items:
+          description: Return items
+          items:
+            properties:
+              exchangeItem:
+                properties:
+                  id:
+                    description: ID of exchange line item
+                    title: ID
+                    type: string
+                required:
+                  - string
+                title: Exchange item
+                type: object
+              id:
+                description: Return item ID.
+                title: ID
+                type: string
+              orderItem:
+                description: Order line item
+                properties:
+                  id:
+                    description: 'Line item ID in original order. Note: There can be more than return item for an original line item, with different quantity, return reasons, etc.'
+                    title: ID
+                    type: string
+                required:
+                  - index
+                title: Order item
+                type: object
+              quantity:
+                $ref: '#/components/schemas/item-quantity.schema'
+                title: Quantity
+              reason:
+                description: Return reason
+                examples:
+                  - Too big
+                  - Other
+                type: string
+              refund:
+                description: Refund
+                properties:
+                  amount:
+                    $ref: '#/components/schemas/money.schema'
+                    title: Amount
+                  pendingAmount:
+                    $ref: '#/components/schemas/money.schema'
+                    title: Planned amount
+                  pendingTaxAmount:
+                    $ref: '#/components/schemas/money.schema'
+                    description: Taxes.
+                    title: Taxes
+                  taxAmount:
+                    $ref: '#/components/schemas/money.schema'
+                    description: Taxes.
+                    title: Taxes
+                  type:
+                    description: Refund method
+                    enum:
+                      - credit
+                      - refund
+                    type: string
+                required:
+                  - amount
+                  - pendingAmount
+                  - pendingTaxAmount
+                  - taxAmount
+                  - type
+                type: object
+            required:
+              - item
+              - quantity
+              - reason
+            type: object
+          type: array
+        order:
+          description: Original order.
+          properties:
+            id:
+              description: Order ID.
+              example: abc123
+              title: ID
+              type: string
+          required:
+            - id
+          title: Order
+          type: object
+        shipment:
+          description: Shipment, if has been made
+          properties:
+            carrier:
+              description: Carrier code
+              title: Carrier
+              type: string
+            status:
+              description: Status of shipment
+              enum:
+                - pre_transit
+                - transit
+                - delivered
+                - cancelled
+                - flagged
+              title: Status
+              type: string
+            tracker:
+              description: Tracking number
+              title: Tracker
+              type: string
+          title: Shipment
+          type: object
+        source:
+          properties:
+            emailAddress:
+              description: Email address.
+              format: email
+              title: Email address
+              type: string
+            mailingAddress:
+              $ref: '#/components/schemas/address.schema'
+              description: Mailing address returned items are sent from.
+              title: Mailing address
+            name:
+              $ref: '#/components/schemas/person-name.schema'
+              description: Name of returner.
+              title: Name
+            phoneNumber:
+              $ref: '#/components/schemas/phone-number.schema'
+              description: Phone number of returner.
+              title: Phone number
+          required:
+            - emailAddress
+            - mailingAddress
+            - name
+            - phoneNumber
+          type: object
+        status:
+          $ref: '#/components/schemas/return-status.schema'
+          description: Return status.
+          title: Status
+        updatedAt:
+          description: Time of last update.
+          format: date-time
+          title: Updated at
+          type: string
+      required:
+        - createdAt
+        - destination
+        - source
+        - id
+        - order
+        - items
+        - status
+        - updatedAt
+      title: Return
+      type: object
+    return-status.schema:
+      description: |
+        Return status.
+
+        * manual_review: Return requires pre-shipment merchant authorization.
+        * open: Return has been approved is awaiting shipment.
+        * transit: Return shipment is in transit.
+        * delivered: Return shipment has been delievered and awaiting processing.
+        * flagged: A problem with return processing requires merchant action.
+        * cancelled: The return has been cancelled.
+        * closed: The return has been completed.
+      enum:
+        - manual_review
+        - open
+        - transit
+        - delivered
+        - flagged
+        - cancelled
+        - closed
+      example: open
+      title: Return status
+      type: string
+    webhook-create.schema:
+      description: Webhook create.
+      properties:
+        backfill:
+          default: false
+          description: Create events for already-existing items
+          title: Backfill
+          type: boolean
+        callback:
+          $ref: '#/components/schemas/https-callback.schema'
+          description: HTTPS callback to POST events.
+          title: HTTPS callback
+        externalId:
+          default: null
+          description: Optional external identifier.
+          title: External ID
+          type:
+            - string
+            - 'null'
+        topic:
+          $ref: '#/components/schemas/webhook-topic.schema'
+          description: Topic.
+          title: Topic
+      required:
+        - callback
+        - topic
+      title: Webhook create
+      type: object
+    webhook-read.schema:
+      description: Webhook read.
+      properties:
+        callback:
+          $ref: '#/components/schemas/https-callback.schema'
+          description: HTTPS callback URL to POST events.
+          title: Callback
+        createdAt:
+          description: Time created.
+          format: date-time
+          title: Created at.
+          type: string
+        externalId:
+          default: null
+          description: Optional external identifier.
+          title: External ID
+          type:
+            - string
+            - 'null'
+        id:
+          description: Webhook ID.
+          readonly: true
+          title: ID
+          type: string
+        topic:
+          $ref: '#/components/schemas/webhook-topic.schema'
+          description: Topic.
+          title: Topic
+        updatedAt:
+          description: Last time updated.
+          format: date-time
+          title: Updated at.
+          type: string
+      required:
+        - callback
+        - createdAt
+        - externalId id
+        - updatedAt
+        - topic
+      title: Webhook read
+      type: object
+    webhook-topic.schema:
+      description: Webhook topic.
+      enum:
+        - return
+      title: Webhook topic
+      type: string
+    webhook-update.schema:
+      description: Webhook update.
+      properties:
+        callback:
+          $ref: '#/components/schemas/https-callback.schema'
+          description: HTTPS callback to POST events.
+          title: HTTPS callback
+        externalId:
+          default: null
+          description: Optional external identifier.
+          title: External ID
+          type:
+            - string
+            - 'null'
+      required:
+        - callback
+      title: Webhook update
+      type: object
+    weight.schema:
+      description: Weight.
+      properties:
+        kg:
+          description: Weight in kilograms
+          examples:
+            - 0.021
+            - 1.4
+          minimum: 0
+          title: Kilograms
+          type: number
+      title: Weight
+      type: object
+  securitySchemes:
+    Bearer:
+      scheme: Bearer
+      type: http
+    UserBearer:
+      scheme: Bearer
+      type: http
+info:
+  contact:
+    email: engineering-admin@getredo.com
+    name: Redo Engineering
+  description: |
+    ## Endpoints
+
+    Endpoints are authenticated using the Bearer authorization scheme, using the
+    REDO_API_SECRET.
+
+    ```txt
+    GET /v2.2/resource HTTP/1.1
+    Authorization: Bearer 77bb7598b7a972475cc7c7e171ec33af
+    Host: api.getredo.com
+    ```
+
+    ## Webhooks
+
+    Webhooks are authenticated using the Bearer authorization scheme, using
+    a secret supplied by the subscriber.
+
+    ```txt
+    POST /events HTTP/1.1
+    Authorization: Bearer subscriberauth123
+    Host: subscriber.example.com
+    ```
+
+    Webhook events are delivered in order for each individual subject (e.g.
+    return).
+
+    If the response is not a 2xx status code, the event will be retried multiple
+    times before discarding it.
+  title: Redo API
+  version: 2.2.0
+openapi: 3.1.0
+paths:
+  /__return:
+    description: Return event webhook.
+    post:
+      operationId: Webhook return event
+      requestBody:
+        content:
+          application/json:
+            schema:
+              description: Return event
+              properties:
+                at:
+                  description: Event time
+                  format: date-time
+                  title: At
+                  type: string
+                order:
+                  $ref: '#/components/schemas/order-read.schema'
+                  description: Order for return.
+                  title: Order
+                return:
+                  $ref: '#/components/schemas/return-read.schema'
+                  description: Return.
+                  title: Return
+                type:
+                  description: Event type
+                  enum:
+                    - backfill
+                    - created
+                    - updated
+                  type: string
+              type: object
+        description: |
+          Return event webhook.
+
+          <!-- theme: warning -->
+          > #### Note
+          >
+          > This is not an actual Redo API endpoint, but a webhook.
+        required: true
+      responses:
+        2xx:
+          description: Success. Return a 2xx status code to indicate success.
+        default:
+          description: Error. The event will be retried multiple times and then discarded.
+      security:
+        - UserBearer: []
+      summary: Return event [Webhook]
+      tags:
+        - Returns
+    summary: Return event [Webhook]
+  /returns/{returnId}/comments:
+    description: Return comment.
+    get:
+      description: List return comments.
+      operationId: Return comments get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  comments:
+                    description: Return comments.
+                    items:
+                      $ref: '#/components/schemas/comment.schema'
+                    title: Comments
+                    type: array
+                required:
+                  - comments
+                type: object
+          description: Success
+      summary: List return comments
+      tags:
+        - Returns
+    parameters:
+      - $ref: '#/components/parameters/return-id.param'
+    post:
+      description: Create return comment.
+      operationId: Return comment create
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                comment:
+                  $ref: '#/components/schemas/comment.schema'
+              required:
+                - comment
+              type: object
+        required: true
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                properties:
+                  comment:
+                    $ref: '#/components/schemas/comment.schema'
+                required:
+                  - comment
+                type: object
+          description: Created
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Create return comment
+      tags:
+        - Returns
+    summary: Return comment
+  /returns/{returnId}/status:
+    description: Return status.
+    get:
+      description: Get return status.
+      operationId: Return status get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  status:
+                    $ref: '#/components/schemas/return-status.schema'
+                required:
+                  - status
+                type: object
+          description: Success
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Get return status
+      tags:
+        - Returns
+    parameters:
+      - $ref: '#/components/parameters/return-id.param'
+    put:
+      description: Update return status.
+      operationId: Return status update
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                status:
+                  $ref: '#/components/schemas/return-status.schema'
+              required:
+                - status
+              type: object
+        required: true
+      responses:
+        '204':
+          description: Updated
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Update return status
+      tags:
+        - Returns
+    summary: Return status
+  /stores/{storeId}/returns:
+    description: List of returns for store.
+    get:
+      description: List returns, sorted by most recent to least recent.
+      operationId: Returns list
+      parameters:
+        - $ref: '#/components/parameters/page-continue.param'
+        - $ref: '#/components/parameters/page-size.param'
+        - $ref: '#/components/parameters/updated-at-max.param'
+        - $ref: '#/components/parameters/updated-at-min.param'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  orders:
+                    items:
+                      $ref: '#/components/schemas/order-read.schema'
+                    type: array
+                  returns:
+                    items:
+                      $ref: '#/components/schemas/return-read.schema'
+                    type: array
+                required:
+                  - orders
+                  - returns
+                type: object
+          description: Success
+          headers:
+            X-Page-Next:
+              $ref: '#/components/headers/page-next.header'
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: List returns
+      tags:
+        - Returns
+    parameters:
+      - $ref: '#/components/parameters/store-id.param'
+    summary: Returns
+  /stores/{storeId}/webhooks:
+    description: Webhooks.
+    get:
+      description: List webhooks for store.
+      operationId: Webhooks list
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  webhooks:
+                    items:
+                      $ref: '#/components/schemas/webhook-read.schema'
+                    type: array
+                required:
+                  - webhooks
+                type: object
+          description: Success
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      summary: List webhooks
+      tags:
+        - Webhooks
+    parameters:
+      - $ref: '#/components/parameters/store-id.param'
+    post:
+      description: Create webhook for store. Or if webhook already exists with `externalId`, update it.
+      operationId: Webhook create
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                webhook:
+                  $ref: '#/components/schemas/webhook-create.schema'
+              type: object
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  webhook:
+                    $ref: '#/components/schemas/webhook-read.schema'
+                type: object
+          description: Updated
+        '201':
+          content:
+            application/json:
+              schema:
+                properties:
+                  webhook:
+                    $ref: '#/components/schemas/webhook-read.schema'
+                type: object
+          description: Created
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Create or update webhook
+      tags:
+        - Webhooks
+    summary: Webhooks
+  /webhooks/{webhookId}:
+    delete:
+      description: Delete a webbhook.
+      operationId: Webhook delete
+      responses:
+        '204':
+          description: Deleted
+      security:
+        - Bearer: []
+      summary: Delete webhook
+      tags:
+        - Webhooks
+    description: Webhook.
+    get:
+      description: Get a webhook.
+      operationId: Webhook get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  webhook:
+                    $ref: '#/components/schemas/webhook-read.schema'
+                required:
+                  - webhook
+                type: object
+          description: Success
+      summary: Get webhook
+      tags:
+        - Webhooks
+    parameters:
+      - $ref: '#/components/parameters/webhook-id.param'
+    put:
+      description: Update a webhook.
+      operationId: Webhook update
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                webhook:
+                  $ref: '#/components/schemas/webhook-update.schema'
+              required:
+                - webbhook
+              type: object
+        required: true
+      responses:
+        '204':
+          description: Success
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      summary: Update webhook
+      tags:
+        - Webhooks
+    summary: Webhook
+  /webhooks/{webhookId}/replay:
+    description: Webhook replay.
+    parameters:
+      - $ref: '#/components/parameters/webhook-id.param'
+    post:
+      description: Replay a webhook.
+      operationId: Webhook replay
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                start:
+                  format: date-time
+                  type: string
+              required:
+                - start
+              type: object
+        required: true
+      responses:
+        '202':
+          description: Success
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      summary: Replay webhook
+      tags:
+        - Webhooks
+    summary: Webhook replay
+servers:
+  - url: https://api.getredo.com/v2.2
+webhooks:
+  return:
+    description: Return event webhook.
+    post:
+      operationId: Webhook return event
+      requestBody:
+        content:
+          application/json:
+            schema:
+              description: Return event
+              properties:
+                at:
+                  description: Event time
+                  format: date-time
+                  title: At
+                  type: string
+                order:
+                  $ref: '#/components/schemas/order-read.schema'
+                  description: Order for return.
+                  title: Order
+                return:
+                  $ref: '#/components/schemas/return-read.schema'
+                  description: Return.
+                  title: Return
+                type:
+                  description: Event type
+                  enum:
+                    - backfill
+                    - created
+                    - updated
+                  type: string
+              type: object
+        description: |
+          Return event webhook.
+
+          <!-- theme: warning -->
+          > #### Note
+          >
+          > This is not an actual Redo API endpoint, but a webhook.
+        required: true
+      responses:
+        2xx:
+          description: Success. Return a 2xx status code to indicate success.
+        default:
+          description: Error. The event will be retried multiple times and then discarded.
+      security:
+        - UserBearer: []
+      summary: Return event [Webhook]
+      tags:
+        - Returns
+    summary: Return event [Webhook]