> ## Documentation Index
> Fetch the complete documentation index at: https://developer.fabric.inc/llms.txt
> Use this file to discover all available pages before exploring further.

# Acknowledge a backorder

> Acknowledge a backorder by providing the order id.



## OpenAPI

````yaml dropship_orders.openapi put /v1/retailers/{retailer_id}/orders/{id}/acknowledge-backorder/
openapi: 3.0.0
info:
  title: Dropship Orders API
  version: 1.0.0
  description: |
    Endpoints for retrieving and creating orders.
servers:
  - url: https://marketplace-api.fabric.inc
    description: Production server
security:
  - Bearer: []
tags:
  - name: Orders
    description: Order retrieval and creation
paths:
  /v1/retailers/{retailer_id}/orders/{id}/acknowledge-backorder/:
    put:
      tags:
        - Orders
      summary: Acknowledge a backorder
      description: Acknowledge a backorder by providing the order id.
      parameters:
        - name: id
          in: path
          description: >-
            The unique order ID. This ID is generated when a new order is
            created.
          required: true
          schema:
            type: integer
          example: 1009
        - name: retailer_id
          in: path
          required: true
          description: >-
            The unique retailer ID. In the Dropship UI this is called the
            **Merchant ID**. To find your Merchant ID, click your merchant name
            in the top nav.
          schema:
            type: number
          example: 500
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetailOrderBody'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetailerOrder'
components:
  schemas:
    RetailOrderBody:
      type: object
      required:
        - purchase_order_number
        - ordered_at
      properties:
        customer_order_number:
          type: string
          title: Customer order number
          description: Customer's original reference number for the order.
          maxLength: 64
          nullable: true
          example: CUST-20230401-XYZ
        purchase_order_number:
          type: string
          title: Purchase order number
          description: Purchase order number assigned by the retailer.
          minLength: 1
          example: PO-45678
        retailer_order_number:
          type: string
          title: Retailer order number
          description: Internal retailer system reference number.
          minLength: 1
          example: RET-89012
        brand_identifier:
          type: string
          title: Brand identifier
          description: Identifier used to associate the order with a specific brand.
          maxLength: 64
          nullable: true
          example: BRD-001
        connection_id:
          type: integer
          title: Connection ID
          description: Unique identifier for the retailer-brand platform connection.
          example: 101
        requested_shipping_method_id:
          type: integer
          title: Requested shipping method ID
          description: ID corresponding to the requested shipping method.
          example: 5
        allow_shipping_label_generation:
          type: boolean
          title: Allow shipping label generation
          description: >-
            Indicates whether the system allows generation of shipping labels
            for this order.
          example: true
        shipping_charged:
          type: string
          title: Shipping charged
          description: Shipping fees charged to the customer.
          format: decimal
          example: '10.00'
        is_gift:
          type: boolean
          title: Is gift
          description: Whether the order was marked as a gift.
          example: false
        gift_fee:
          type: string
          title: Gift fee
          description: Fee charged for gift wrapping or gift services.
          format: decimal
          nullable: true
          example: '5.00'
        is_replacement:
          type: boolean
          title: Is replacement
          description: Whether the order was created as a replacement.
          example: false
        ordered_at:
          type: string
          format: date-time
          title: Ordered at
          description: Date and time when the order was placed.
          example: '2024-03-15T08:00:00Z'
        acknowledged_at:
          type: string
          format: date-time
          title: Acknowledged at
          description: Date and time when the order was acknowledged.
          nullable: true
          example: '2024-03-16T09:00:00Z'
        fulfilled_at:
          type: string
          format: date-time
          title: Fulfilled at
          description: Date and time when the order was fulfilled.
          nullable: true
          example: '2024-03-17T10:00:00Z'
        pickup_on:
          type: string
          format: date
          title: Pickup on
          description: Scheduled pickup date for the order, if applicable.
          nullable: true
          example: '2024-03-18'
        on_hold_at:
          type: string
          format: date-time
          title: On hold at
          description: Date and time when the order was placed on hold.
          nullable: true
          example: '2024-03-19T11:00:00Z'
        on_hold_until:
          type: string
          format: date
          title: On hold until
          description: Date until which the order remains on hold.
          nullable: true
          example: '2024-03-25'
        backordered_until:
          type: string
          format: date-time
          title: Backordered until
          description: Expected date when a backordered item will be available.
          nullable: true
          example: '2024-04-01T08:00:00Z'
        backorder_acknowledged_at:
          type: string
          format: date-time
          title: Backorder acknowledged at
          description: Date and time when the backorder status was acknowledged.
          nullable: true
          example: '2024-03-28T08:00:00Z'
        canceled_at:
          type: string
          format: date-time
          title: Canceled at
          description: Date and time when the order was canceled.
          nullable: true
          example: '2024-03-29T08:00:00Z'
        fill_time:
          type: string
          format: decimal
          title: Fill time
          description: Estimated time in hours to fill the order.
          nullable: true
          example: '48.00'
        signature:
          type: string
          title: Signature
          description: Signature requirement for order delivery.
          nullable: true
          enum:
            - required
            - not_required
            - adult
          example: required
        is_priority:
          type: boolean
          title: Is priority
          description: Indicates whether the order is prioritized for fulfillment.
          example: true
    RetailerOrder:
      required:
        - ordered_at
        - purchase_order_number
      type: object
      properties:
        id:
          description: Order ID
          example: 1016
          type: integer
          readOnly: true
        customer_order_number:
          description: Customer order number
          example: '100000'
          maxLength: 64
          type: string
          nullable: true
        purchase_order_number:
          description: Purchase order number
          example: 1234-100000
          minLength: 1
          type: string
        retailer_order_number:
          description: Retailer order number
          example: '1225466845'
          minLength: 1
          type: string
        brand_identifier:
          description: Vendor identifier
          example: '423432322'
          maxLength: 64
          type: string
          nullable: true
        retailer:
          $ref: '#/components/schemas/RetailerShort'
        brand:
          $ref: '#/components/schemas/BrandShort'
        brands:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/BrandShort'
        connection_id:
          description: A numeric connection ID
          example: 10
          type: integer
        shipping_method:
          $ref: '#/components/schemas/ShippingMethod'
        requested_shipping_method_id:
          description: ID of the requested shipping method
          example: 768
          type: integer
        requested_shipping_method:
          $ref: '#/components/schemas/GenericShippingMethod'
        shipment_count:
          description: Shipment count
          example: 1
          type: integer
          readOnly: true
        invoice_count:
          description: Invoice count
          example: 1
          type: integer
          readOnly: true
        bill_to:
          $ref: '#/components/schemas/Address'
        sold_to:
          $ref: '#/components/schemas/Address'
        ship_to:
          $ref: '#/components/schemas/Address'
        ship_from:
          $ref: '#/components/schemas/Address'
        return_to:
          $ref: '#/components/schemas/Address'
        allow_shipping_label_generation:
          description: >-
            true: Automatically generates shipping labels based on the carrier |
            false: Does not support generation of shipping labels
          example: true
          type: boolean
        subtotal_charged:
          description: Subtotal amount excluding shipping
          example: '25.96'
          type: string
          readOnly: true
        shipping_charged:
          description: Shipped charged
          example: '2.99'
          type: string
          format: decimal
        is_gift:
          description: 'true: Order is a gift | false: Order is not a gift'
          example: false
          type: boolean
        gift_fee:
          description: Gift fee (if applicable)
          example: null
          type: string
          format: decimal
          nullable: true
        is_replacement:
          description: 'true: order is a replacement | false: order is not a replacement'
          example: false
          type: boolean
        status:
          description: Order status
          example: open
          minLength: 1
          type: string
          readOnly: true
        currency:
          $ref: '#/components/schemas/Currency'
        is_acknowledged:
          description: 'true: Order is acknowledged | false: Order is not acknowledged'
          example: false
          type: boolean
          readOnly: true
        ordered_at:
          description: Time of order finalization (UTC format)
          example: '2017-08-01T12:00:00Z'
          type: string
          format: date-time
        acknowledged_at:
          description: Time of order acknowledgement (UTC format)
          example: '2022-08-01T12:00:00Z'
          type: string
          format: date-time
          nullable: true
        fulfill_by:
          description: Time when order will be completely fulfilled (UTC format)
          example: '2022-12-19T03:59:59Z'
          type: string
          readOnly: true
        fulfilled_at:
          description: Time of order fulfillment (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        closed_at:
          description: Time of complete order fulfillment (UTC format)
          example: null
          type: string
          format: date-time
          readOnly: true
        received_at:
          description: Time of when order was received (UTC format)
          example: null
          type: string
          format: date-time
          readOnly: true
        is_on_hold:
          description: 'true: Order is on hold | false: Order is not on hold'
          example: false
          type: boolean
          readOnly: true
        pickup_on:
          description: Time of when order was picked up (UTC format)
          example: null
          type: string
          format: date
          nullable: true
        on_hold_at:
          description: Time of when order got placed on hold (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        on_hold_until:
          description: Date till when the order will be on hold
          example: null
          type: string
          format: date
          nullable: true
        backordered_until:
          description: Time till when product or order is backordered (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        backorder_acknowledged_at:
          description: Time of backorder acknowledgement (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        canceled_at:
          description: Time of order cancellation (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        updated_at:
          description: Time of order update (UTC format)
          example: '2022-08-03T17:45:11Z'
          type: string
          format: date-time
          readOnly: true
        order_lines:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/RetailerOrderLine'
        cancels:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Cancel'
        shipments:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/RetailerShipmentList'
        attachments:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Attachment'
        memos:
          type: array
          items:
            $ref: '#/components/schemas/Memo'
          readOnly: true
        memos_count:
          description: Total memos
          example: 1
          type: integer
          readOnly: true
        unread_memos_count:
          description: Number of unread memos
          example: 0
          type: integer
          readOnly: true
        tags:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/ObjectTagItem'
        gift_message:
          description: Gift message
          example: Gift
          type: string
          readOnly: true
        fill_time:
          description: Fill time
          example: null
          type: string
          format: decimal
          nullable: true
        invoices:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Invoice'
        signature:
          description: Represents whether signature is required
          example: null
          type: string
          nullable: true
          enum:
            - required
            - not_required
            - adult
        rmas:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/RMA'
        credits:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Credit'
        order_batches:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderBatchId'
        metadata:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderMetadataValue'
        connection_shipping_provider_account:
          $ref: '#/components/schemas/ConnectionShippingProviderAccount'
        is_priority:
          description: 'true: Priority order | false: Not a priority order'
          example: false
          type: boolean
        priority_user:
          $ref: '#/components/schemas/UserShort'
        envelopes:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Envelope'
    RetailerShort:
      required:
        - code
        - name
      type: object
      properties:
        id:
          description: Retailer ID
          example: 500
          type: integer
          readOnly: true
        name:
          description: Retailer name
          example: Demo Retailer
          maxLength: 64
          minLength: 1
          type: string
        code:
          description: Retailer code, which is retailer name in lower case and hyphenated
          example: demo-retailer
          maxLength: 32
          minLength: 1
          pattern: ^[-a-zA-Z0-9_]+$
          type: string
          format: slug
        logo_url:
          description: URL of retailer logo
          example: >-
            https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png
          minLength: 1
          type: string
          format: uri
          readOnly: true
        cover_url:
          description: URL of retailer cover image
          example: >-
            https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg
          minLength: 1
          type: string
          format: uri
          readOnly: true
        profile_tile_url:
          description: URL of retailer profile image
          example: >-
            https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg
          minLength: 1
          type: string
          format: uri
          readOnly: true
        joined_at:
          description: Time of retailer joining Dropship (UTC format)
          example: '2021-08-03T17:24:12Z'
          type: string
          format: date-time
          readOnly: true
        is_rcn_retailer:
          description: >-
            true: Retailer is in Dropship network; Retailer is not in Dropship
            network
          example: false
          type: boolean
        is_onboarded:
          description: 'true: Retailer is onboarded | false: Retailer is not onboarded'
          example: false
          type: boolean
        platform:
          description: Platform on which retailer is onboarded
          example: fabric
          type: string
          enum:
            - fabric
        requires_subscription:
          description: Represent whether retailer requires subscription to use the platform
          example: disabled
          type: string
          enum:
            - disabled
            - enabled
            - upcoming
        brand_permit_creation_allowed:
          description: >-
            true: Platform allows creation of brand permit | false: Platform
            doesn't require creation of brand permit
          example: false
          type: boolean
        website:
          description: Website URL
          example: https://demoabc.com
          maxLength: 100
          type: string
          format: uri
          nullable: true
        status:
          description: Retailer status
          example: active
          type: string
          enum:
            - active
            - setup
            - ghost
    BrandShort:
      required:
        - code
      type: object
      properties:
        id:
          description: Vendor (brand) ID
          example: 500
          type: integer
          readOnly: true
        name:
          description: Vendor name
          example: Marla Cielo
          maxLength: 64
          minLength: 1
          type: string
        code:
          description: Vendor code, which is vendor name in lower case and underscore
          example: demo-brand
          maxLength: 64
          minLength: 1
          pattern: ^[-a-zA-Z0-9_]+$
          type: string
          format: slug
        joined_at:
          description: Time when vendor joined Dropship (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        logo_url:
          description: URL of the brand logo
          example: https://images.revcascade.com/retailers/defaults/logo-lg.png
          minLength: 1
          type: string
          format: uri
          readOnly: true
        cover_url:
          description: URL of the cover image
          example: https://images.revcascade.com/retailers/defaults/cover.png
          minLength: 1
          type: string
          format: uri
          readOnly: true
        profile_tile_url:
          description: URL of the profile image
          example: https://images.revcascade.com/retailers/defaults/profile-tile.png
          minLength: 1
          type: string
          format: uri
          readOnly: true
        website:
          description: URL of brand website
          example: null
          maxLength: 100
          type: string
          format: uri
          nullable: true
        is_onboarded:
          description: 'true: Vendor is onboarded | false: Vendor is not onboarded'
          example: false
          type: boolean
          readOnly: true
        is_on_rcn:
          description: 'true: is on Dropship network | false: not on Dropship network'
          example: false
          type: boolean
        requires_subscription:
          description: Represents whether subscription is required
          example: enabled
          type: string
          enum:
            - disabled
            - enabled
            - upcoming
        subscription_expires_at:
          description: Subscription expiry Time (UTC format)
          example: '2024-09-19T13:32:10Z'
          type: string
          format: date-time
          nullable: true
        grace_period_ends_at:
          description: Time of grace period expiration (UTC format)
          example: '2024-10-26T13:32:10Z'
          type: string
          format: date-time
          nullable: true
        subscription_is_expired:
          description: 'true: subscription is expired | false: subscription is active'
          example: false
          type: boolean
          readOnly: true
        subscription_is_on_grace_period:
          description: >-
            true: subscription is on grace period | false: subscription is not
            on grace period
          example: false
          type: boolean
          readOnly: true
        subscription_is_delinquent:
          description: 'true: subscription is overdue | false: subscription is paid'
          example: false
          type: boolean
          readOnly: true
        inventory_policy:
          description: Inventory policy
          example: managed
          type: string
          enum:
            - unmanaged
            - managed
            - use_variant_policy
        status:
          description: Vendor status
          example: active
          type: string
          enum:
            - active
            - pending
            - inactive
    ShippingMethod:
      required:
        - code
        - name
      type: object
      properties:
        id:
          description: ID of shipping method
          example: 5
          type: integer
          readOnly: true
        name:
          description: Name of shipping method
          example: White Glove Bronze
          maxLength: 64
          minLength: 1
          type: string
        code:
          description: Code of shipping method
          example: cory_white_glove
          maxLength: 64
          minLength: 1
          type: string
        type:
          description: Type of shipping method
          example: ltl (less than truck load)
          type: string
          enum:
            - small_parcel
            - ltl
        carrier:
          $ref: '#/components/schemas/Carrier'
        generic_shipping_method:
          $ref: '#/components/schemas/GenericShippingMethod'
    GenericShippingMethod:
      required:
        - description
        - name
      type: object
      properties:
        id:
          description: ID of shipping method
          example: 5
          type: integer
          readOnly: true
        name:
          description: Name of shipping method
          example: LTL
          maxLength: 32
          minLength: 1
          type: string
        description:
          description: Description of shipping method
          example: Less than truckload (LTL)
          maxLength: 128
          minLength: 1
          type: string
        type:
          description: Type of shipping method
          example: ltl
          type: string
          enum:
            - small_parcel
            - ltl
    Address:
      required:
        - city
        - country
        - name1
        - postal_code
        - province
        - street1
      type: object
      properties:
        id:
          description: Address ID
          example: 10
          type: integer
          readOnly: true
        type:
          description: Type of address
          example: residential
          type: string
          nullable: true
          enum:
            - residential
            - commercial
        name1:
          description: Name of the primary contact?
          example: Demo Brand, Inc
          maxLength: 64
          minLength: 1
          type: string
        name2:
          description: Name of the alternative contact?
          example: null
          maxLength: 64
          type: string
          nullable: true
        street1:
          description: Line 1 of the address
          example: 1332 Hermosa Ave
          maxLength: 128
          minLength: 1
          type: string
        street2:
          description: Line 2 of the address
          example: null
          maxLength: 128
          type: string
          nullable: true
        city:
          description: City name
          example: Hermosa Beach
          maxLength: 64
          minLength: 1
          type: string
        province:
          description: State name
          example: CA
          maxLength: 32
          minLength: 1
          type: string
        postal_code:
          description: Postal code
          example: '90254'
          maxLength: 32
          minLength: 1
          type: string
        country:
          description: Country name
          example: US
          maxLength: 128
          minLength: 1
          type: string
        phone1:
          description: Primary contact number
          example: '3105551212'
          maxLength: 32
          type: string
          nullable: true
        phone2:
          description: Alternate contact number
          example: '3105551213'
          maxLength: 32
          type: string
          nullable: true
        fax:
          description: Fax number
          example: null
          maxLength: 32
          type: string
          nullable: true
        email:
          description: Contact email address
          example: null
          maxLength: 128
          type: string
          nullable: true
        federal_tax_id:
          description: 'Federal tax ID '
          example: null
          maxLength: 32
          type: string
          nullable: true
    Currency:
      type: object
      properties:
        id:
          description: Currency ID
          example: 1
          type: integer
          readOnly: true
        name:
          description: Currency name
          example: United States Dollar
          maxLength: 200
          type: string
        symbol:
          description: Currency symbol
          example: $
          maxLength: 5
          type: string
          nullable: true
        unit:
          description: Currency unit
          example: USD
          type: string
          readOnly: true
    RetailerOrderLine:
      required:
        - ordered_at
        - quantity
      type: object
      properties:
        id:
          description: Order line ID
          example: 10013
          type: integer
          readOnly: true
        order_line_number:
          description: Order line number (auto-incremental number)
          example: SampleOL-1
          type: string
          readOnly: true
        quantity:
          description: Total products in the order
          example: 2
          type: integer
        quantity_open:
          description: Quantity to be shipped
          example: 2
          type: integer
          readOnly: true
        quantity_shipped:
          description: Quantity shipped
          example: 0
          type: integer
          readOnly: true
        quantity_returned:
          description: Quantity returned
          example: 0
          type: integer
          readOnly: true
        quantity_canceled:
          description: Quantity cancelled
          example: 0
          type: string
          readOnly: true
        quantity_invoiced:
          description: Quantity invoiced
          example: 0
          type: integer
          readOnly: true
        packages_per_quantity:
          description: Number of packages per quantity
          type: integer
        price:
          description: Discounted price
          example: '8.99'
          type: string
          readOnly: true
        net_price:
          description: Net price
          example: '5.39'
          type: string
          readOnly: true
        subtotal:
          description: Subtotal amount
          example: '17.98'
          type: string
          readOnly: true
        estimated_price:
          description: Estimated price
          example: null
          type: string
          format: decimal
          nullable: true
        shipping_charged:
          description: Shipping cost
          example: '0.00'
          type: string
          format: decimal
        gift_fee:
          description: Gift fee
          example: null
          type: string
          format: decimal
          nullable: true
        subtotal_charged:
          description: Subtotal charged
          example: '17.98'
          type: string
          readOnly: true
        tax_charged:
          description: Tax charged
          example: '0.00'
          type: string
          format: decimal
        total_charge:
          description: Total charge
          example: '12'
          type: string
          format: decimal
        status:
          description: Order status
          example: open
          minLength: 1
          type: string
          readOnly: true
        fulfill_by:
          description: >-
            Time all products in the order are expected to be completely
            fulfilled. Automatically determined based on a combination of item
            lead time and the connection's SLA.
          example: '2022-12-19T03:59:59Z'
          type: string
          readOnly: true
        canceled_at:
          description: Time of cancellation (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        ordered_at:
          description: Time of order finalization (UTC format)
          example: '2022-08-01T12:00:00Z'
          type: string
          format: date-time
        backordered_until:
          description: Time till when product is backordered (UTC format)
          example: null
          type: string
          format: date-time
          readOnly: true
        variant:
          description: Details of product variant
          type: string
        metadata:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderMetadataValue'
    Cancel:
      required:
        - reason_id
      type: object
      properties:
        id:
          description: Cancellation ID
          example: 456
          type: integer
          readOnly: true
        retailer:
          $ref: '#/components/schemas/RetailerMini'
        brand:
          $ref: '#/components/schemas/BrandMini'
        canceled_at:
          description: Time of cancellation (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        canceled_by:
          description: User that initiated cancellation
          example: retailer
          type: string
          nullable: true
          enum:
            - retailer
            - brand
        cancel_lines:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/CancelLine'
        reason_id:
          description: Reason ID associated with cancellation
          example: 879
          type: integer
        order_id:
          description: Order ID
          example: '5465'
          type: integer
          readOnly: true
        purchase_order_number:
          description: Purchase order number
          example: CS192168
          minLength: 1
          type: string
          readOnly: true
        reason:
          description: Cancellation reason
          example: Incorrect
          minLength: 1
          type: string
          readOnly: true
        acknowledged_at:
          description: Time of cancellation acknowledgement (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
    RetailerShipmentList:
      required:
        - order_id
      type: object
      properties:
        id:
          description: Shipment ID
          example: 767
          type: integer
          readOnly: true
        order_id:
          description: Order ID
          example: 677
          type: integer
        batch_number:
          description: Batch number of shipment
          example: 6
          maximum: 2147483647
          minimum: -2147483648
          type: integer
          nullable: true
        label_reference:
          description: Label reference
          example: Sample label 123
          maxLength: 30
          type: string
          nullable: true
        ordered_at:
          description: Time of shipment creation (UTC format)
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        customer_order_number:
          description: Customer order number
          example: '765637'
          minLength: 1
          type: string
          readOnly: true
        retailer_order_number:
          description: Retailer order number
          example: '66367'
          minLength: 1
          type: string
          readOnly: true
        purchase_order_number:
          description: Purchase order number
          example: PO-576
          minLength: 1
          type: string
          readOnly: true
        shipping_method:
          $ref: '#/components/schemas/ShippingMethod'
        shipping_account:
          $ref: '#/components/schemas/ShippingAccount'
        tracking_number:
          description: Tracking number for shipment
          example: 1Z9999999999999988
          maxLength: 128
          type: string
          nullable: true
        tracking_url:
          description: URL for tracking shipment
          example: >-
            https://wwwapps.demo.com/WebTracking/track?track=yes&trackNums=1Z9999999999999988
          type: string
          readOnly: true
        tracking:
          $ref: '#/components/schemas/Tracking'
        status:
          description: Status of shipment
          example: Shipped
          minLength: 1
          type: string
          readOnly: true
        is_acknowledged:
          description: 'true: Shipment is acknowledged | false: Shipment is not acknowledged'
          example: true
          type: boolean
          readOnly: true
        has_commercial_invoice:
          description: >-
            true: Shipment has commercial invoice | Shipment does not have
            commercial invoice
          example: true
          type: boolean
        canceled_at:
          description: Time of cancellation (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        sold_to:
          $ref: '#/components/schemas/Address'
        ship_to:
          $ref: '#/components/schemas/Address'
        ship_from:
          $ref: '#/components/schemas/Address'
        ship_weight:
          description: Shipment weight
          example: 10
          type: number
          nullable: true
        ship_width:
          description: Shipment width
          example: 1
          type: number
          nullable: true
        ship_length:
          description: Shipment length
          example: 1
          type: number
          nullable: true
        ship_height:
          description: Shipment height
          example: 1
          type: number
          nullable: true
        ship_girth:
          description: Shipment girth
          type: string
          readOnly: true
        ship_volume:
          description: Shipment volume
          example: 4
          type: string
          readOnly: true
        valid_packing_slip:
          description: >-
            true: Shipment has a valid packing slip | false: Shipment does not
            valid packing slip
          example: true
          type: boolean
          readOnly: true
        valid_shipping_label:
          description: >-
            true: Shipment has a valid packing slip | false: Shipment does not
            have a valid packing slip
          example: true
          type: boolean
          readOnly: true
        shipping_provider_identifier:
          description: Identifier of the shipping provider
          example: shp_3a61e10243da49ab92f0e3861d5d256b
          maxLength: 64
          type: string
          nullable: true
        error_logs:
          $ref: '#/components/schemas/ErrorLog'
        acknowledged_at:
          description: Time of acknowledgement (UTC format)
          example: '2022-08-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        closed_at:
          description: Time of shipment closure (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        delivered_at:
          description: Time of delivery (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        shipped_at:
          description: Time of shipping (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        updated_at:
          description: Time of shipment update (UTC format)
          example: '2022-09-10T15:25:56Z'
          type: string
          format: date-time
          readOnly: true
        created_at:
          description: Time of shipment creation (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        shipment_lines:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/RetailerShipmentLine'
        signature:
          description: Signature criteria
          example: null
          nullable: true
          enum:
            - required
            - not_required
            - adult
        brand:
          $ref: '#/components/schemas/BrandShort'
        invoice_number:
          description: Invoice number
          example: RC123456
          type: string
          readOnly: true
    Attachment:
      type: object
      properties:
        id:
          description: Attachment or document ID
          example: 268
          type: integer
          readOnly: true
        content_type:
          description: Content type
          example: 1
          type: integer
        object_id:
          description: Attachement object ID
          example: 666
          type: integer
        file:
          description: File name
          example: Sample file
          type: string
          format: uri
          nullable: true
          readOnly: true
        uploaded_by:
          description: User ID that uploaded the attachment
          example: 646
          type: integer
          nullable: true
        visible_by:
          description: User permission who can view the attachment
          example: connections
          type: string
          enum:
            - me
            - connections
            - everyone
        original_filename:
          description: Original file name
          example: Sample1
          maxLength: 255
          type: string
          nullable: true
        filename:
          description: File name used for sharing
          example: Sample1
          maxLength: 255
          type: string
          nullable: true
        tags:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/AttachmentTag'
        url:
          description: URL of attachment
          example: >-
            https://assets.sample.com/attachments/path_to_attachment/attachment.pdf
          minLength: 1
          type: string
          format: uri
    Memo:
      type: object
      properties:
        id:
          description: Memo ID
          example: 1234
          type: integer
          readOnly: true
        text:
          description: Memo text
          example: Immediate requirement
          type: string
        visibility:
          description: Memo visibility
          example: any
          type: string
          enum:
            - any
            - retailer
            - brand
        acknowledged_at:
          description: Time memo acknowledgement (UTC format)
          example: '2022-01-10T15:24:56Z'
          type: string
          readOnly: true
        notify_people:
          description: 'true: notify stakeholders | false: do not notify'
          example: true
          type: boolean
        created_by:
          $ref: '#/components/schemas/UserShort'
        created_by_context:
          description: Represents whether memo is created by retailer or brand?
          example: retailer
          type: string
          nullable: true
          enum:
            - retailer
            - brand
        created_at:
          description: Time of memo creation (UTC format)
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Time of memo update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    ObjectTagItem:
      type: object
      properties:
        id:
          description: Object tag ID
          example: 536
          type: integer
          readOnly: true
        tag:
          description: Object tag
          example: Demo tag
          type: string
          readOnly: true
        created_by:
          $ref: '#/components/schemas/UserShort'
        created_at:
          description: Time of object tag creation (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Time of last update (UTC format)
          example: '2022-10-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    Invoice:
      required:
        - invoice_number
      type: object
      properties:
        id:
          description: Invoice ID
          example: 1
          type: integer
          readOnly: true
        retailer:
          $ref: '#/components/schemas/RetailerShort'
        brand:
          $ref: '#/components/schemas/BrandShort'
        connection_id:
          description: Connection ID
          example: 2
          type: string
          readOnly: true
        currency:
          $ref: '#/components/schemas/Currency'
        invoice_number:
          description: Invoice number
          example: RC123456
          maxLength: 32
          minLength: 1
          type: string
        terms_type:
          description: Types of invoice terms
          example: Previously agreed upon
          type: string
          nullable: true
          enum:
            - End of Month (EOM)
            - No Charge
            - Consignment
            - 10 Days After End of Month (10 EOM)
            - Cash Discount Terms Apply
            - Basic
            - Fixed Date, Late Payment Penalty Applies
            - Extended
            - Discount Not Applicable
            - Fixed Date
            - Previously agreed upon
        terms_description:
          description: Description of invoice terms
          example: Previously agreed upon terms will apply
          type: string
          nullable: true
        terms_net_days_due:
          description: Number of days to pay invoice
          example: 35
          maximum: 2147483647
          minimum: -2147483648
          type: integer
          nullable: true
        terms_date_due:
          description: Payment expected date
          example: null
          type: string
          format: date
          nullable: true
        terms_discount_percent:
          description: Discount percentage on selected term
          example: null
          type: string
          format: decimal
          nullable: true
        order_id:
          description: Order ID related to invoice
          example: O-654
          type: integer
        customer_order_number:
          description: Customer order number (for enduser)
          example: CO-435
          maxLength: 64
          type: string
          nullable: true
        purchase_order_number:
          description: Purchase order number (for retailer)
          example: PO-546
          maxLength: 64
          type: string
          nullable: true
        status:
          description: Invoice status
          example: closed
          type: string
          enum:
            - closed
            - open
        remit_to:
          $ref: '#/components/schemas/Address'
        ship_from:
          $ref: '#/components/schemas/Address'
        sold_to:
          $ref: '#/components/schemas/Address'
        ship_to:
          $ref: '#/components/schemas/Address'
        shipping_carrier_name:
          description: Name of shipping carrier
          example: ALZ carrier
          maxLength: 32
          type: string
          nullable: true
        shipping_carrier_code:
          description: Code of shipping carrier
          example: 230F
          maxLength: 32
          type: string
          nullable: true
        shipping_account_number:
          description: Shipping account number
          example: SH879
          maxLength: 32
          type: string
          nullable: true
        shipping_method_name:
          description: Name of shipping method
          example: Next day delivery
          maxLength: 32
          type: string
          nullable: true
        shipping_method_code:
          description: Code of shipping method
          example: ND
          maxLength: 32
          type: string
          nullable: true
        shipping_tracking_number:
          description: Shipping tracking number
          example: 1Z9999999999999988
          maxLength: 32
          type: string
          nullable: true
        shipping_weight:
          description: Shipping weight
          example: '7.00'
          type: string
          format: decimal
          nullable: true
        notes:
          description: Additional info adding to shipping
          example: Signature required
          type: string
          nullable: true
        invoiced_at:
          description: Time of invoice creation (UTC format)
          example: '2022-05-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        ordered_at:
          description: Time of order finalization (UTC format)
          example: '2022-05-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        shipped_at:
          description: Time of shipping (UTC format)
          example: '2022-05-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        acknowledged_at:
          description: Time of retailer acknowledgement (UTC format)
          example: '2022-06-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        paid_at:
          description: Time of payment (UTC format)
          example: '2022-06-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        closed_at:
          description: Time of complete invoice payment (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        canceled_at:
          description: Time of order cancellation (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        allowances:
          type: array
          items:
            $ref: '#/components/schemas/InvoiceAllowance'
        charges:
          type: array
          items:
            $ref: '#/components/schemas/InvoiceCharge'
        invoice_lines:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/InvoiceLine'
        net_amount:
          description: Total invoice amount (exluding taxes)
          example: '12.89'
          type: string
          format: decimal
          nullable: true
        due_amount:
          description: Pending amount
          example: '2.89'
          type: string
          format: decimal
          nullable: true
        expected_due_amount:
          description: Expected due amount (excluding *allowances* and *charges*)
          example: '2.89'
          type: string
          format: decimal
          nullable: true
        subtotal:
          description: Sub-total
          example: '10.89'
          type: string
          format: decimal
          nullable: true
        tax:
          description: Total tax on the invoice
          example: '2.00'
          type: string
          format: decimal
          nullable: true
        invoice_acceptance:
          $ref: '#/components/schemas/InvoiceAcceptance'
    RMA:
      required:
        - order_id
        - reason_id
      type: object
      properties:
        id:
          description: RMA ID. This ID is required in subsequent endpoints related to RMA.
          example: 4
          type: integer
          readOnly: true
        order_id:
          description: Order ID
          example: 1000
          type: integer
        purchase_order_number:
          description: Purchase order number
          example: CS192168
          minLength: 1
          type: string
          readOnly: true
        rma_number:
          description: RMA number
          example: ABC123
          maxLength: 32
          type: string
          nullable: true
        status:
          description: RMA status. Default is Pending.
          example: Pending
          type: string
          nullable: true
          enum:
            - pending
            - approved
            - rejected
        currency:
          $ref: '#/components/schemas/Currency'
        created_by:
          description: User that initiated RMA
          example: Retailer
          type: string
          nullable: true
          enum:
            - retailer
            - brand
        rmad_at:
          description: Time of RMA creation (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        approved_at:
          description: Time of RMA approval (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        rejected_at:
          description: Time of RMA rejection(UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        ordered_at:
          description: Time of order finalization (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        acknowledged_at:
          description: Time of RMA acknowledgement (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        rma_lines:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/RMALine'
        reason:
          description: Reason for return
          example: Incorrect
          minLength: 1
          type: string
          readOnly: true
        reason_id:
          description: ID associated with return reason
          example: 344
          type: integer
        memos:
          type: array
          items:
            $ref: '#/components/schemas/Memo'
          readOnly: true
        attachments:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Attachment'
        retailer:
          $ref: '#/components/schemas/RetailerShort'
        brand:
          $ref: '#/components/schemas/BrandShort'
        total_amount:
          description: Total amount
          example: '34.00'
          type: string
          readOnly: true
        credits:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Credit'
    Credit:
      type: object
      properties:
        id:
          description: Credit ID
          example: 20
          type: integer
          readOnly: true
        brand:
          $ref: '#/components/schemas/BrandShort'
        retailer:
          $ref: '#/components/schemas/RetailerShort'
        currency:
          $ref: '#/components/schemas/Currency'
        rma:
          $ref: '#/components/schemas/RMA'
        invoice:
          $ref: '#/components/schemas/Invoice'
        order:
          description: Order details
          type: string
        credit_number:
          description: Credit number
          example: '849238'
          maxLength: 32
          type: string
          nullable: true
        credit_lines:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/CreditLine'
        adjustments:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Adjustment'
        acknowledged_at:
          description: Time of credit acknowledgement
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        credited_at:
          description: Time of credit (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        created_at:
          description: Time of creation (UTC format)
          example: '2022-08-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        subtotal:
          description: Subtotal amount
          example: '20.00'
          type: string
          format: decimal
          readOnly: true
        credit_amount:
          description: Credit amount
          example: '24.00'
          type: string
          format: decimal
          readOnly: true
    OrderBatchId:
      type: object
      properties:
        id:
          description: Batch ID of order
          example: 2456
          type: integer
          readOnly: true
    OrderMetadataValue:
      type: object
      properties:
        id:
          description: Metadata ID
          example: 456
          type: integer
          readOnly: true
        name:
          description: Metadata name
          example: MD143
          minLength: 1
          type: string
          readOnly: true
        value:
          description: Metadata value, depending on the *type*
          example: '12'
          type: string
          nullable: true
        type:
          description: Metadata type such as integer, float, etc.
          example: string
          minLength: 1
          type: string
          readOnly: true
        created_at:
          description: Time of metadata creation (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    ConnectionShippingProviderAccount:
      type: object
      properties:
        id:
          description: Shipping carrier account ID
          example: 123
          type: integer
          readOnly: true
        connection:
          $ref: '#/components/schemas/ConnectionShort'
        shipping_provider_account:
          $ref: '#/components/schemas/ShippingProviderAccount'
        shipping_methods:
          $ref: '#/components/schemas/ShippingMethod'
        created_at:
          description: Time of creation (UTC format)
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Time of last update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    UserShort:
      type: object
      properties:
        id:
          description: User ID who accepted or rejected the invoice
          example: 542
          type: integer
          readOnly: true
        first_name:
          description: First name of user
          example: Sample
          maxLength: 64
          type: string
          nullable: true
        last_name:
          description: Last name of user
          example: Demo
          maxLength: 64
          type: string
          nullable: true
        title:
          description: User title
          example: Demo
          maxLength: 64
          type: string
          nullable: true
        status:
          description: User status
          example: Active
          type: string
          enum:
            - active
            - invited
            - locked
        type:
          description: User type
          example: standard
          type: string
          enum:
            - standard
            - api
        photo_url:
          description: URL of the user photo
          example: >-
            https://assets.demo.com/attachments/path_to_attachment/attachment.pdf
          minLength: 1
          type: string
          format: uri
          readOnly: true
        profile_photo:
          description: URL of the user's profile photo
          example: >-
            https://assets.demo.com/attachments/path_to_attachment/attachment.pdf
          minLength: 1
          type: string
          format: uri
          readOnly: true
        is_me:
          description: 'true: user is me: | false: user is not me'
          example: true
          type: boolean
          readOnly: true
    Envelope:
      required:
        - data_interchange_control_number
        - direction
        - functional_identifier
        - interchange_control_number
      type: object
      properties:
        id:
          description: Envelope ID
          example: 663
          type: integer
          readOnly: true
        sender:
          $ref: '#/components/schemas/EdiAccount'
        receiver:
          $ref: '#/components/schemas/EdiAccount'
        edi:
          description: Electronic data exchange (EDI)
          type: string
          readOnly: true
        interchange_control_number:
          description: Interchange control number
          example: 2545
          maximum: 4294967295
          minimum: 0
          type: integer
        data_interchange_control_number:
          description: Data interchange control number
          example: 12455
          maximum: 4294967295
          minimum: 0
          type: integer
        direction:
          description: Direction of envelope
          example: incoming
          type: string
          enum:
            - incoming
            - outgoing
        request_acknowledgment:
          description: 'true: Request is acknowledged | false: Request is not acknowledged.'
          example: true
          type: boolean
        functional_identifier:
          description: Functional identifier
          example: PO
          type: string
          enum:
            - PO
            - IN
            - SH
            - IB
            - FA
            - PR
            - PC
        sub_element_delimiter:
          description: Sub element delimiter
          maxLength: 12
          minLength: 1
          type: string
        segment_delimiter:
          description: Segment delimited
          example: demo12
          maxLength: 12
          minLength: 1
          type: string
        element_delimiter:
          description: Element delimiter
          maxLength: 12
          minLength: 1
          type: string
        accepted_at:
          description: Time of envelope acceptance (UTC format)
          example: '2021-10-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        created_at:
          description: Time of envelope creation (UTC format)
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        rejected_at:
          description: Time of envelope rejection (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        transmitted_at:
          description: Time of envelope transmittance (UTC format)
          example: '2021-11-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        documents:
          items:
            $ref: '#/components/schemas/Document'
        entities:
          items:
            $ref: '#/components/schemas/EnvelopeEntity'
    Carrier:
      type: object
      properties:
        id:
          description: Carrier ID
          example: 229
          type: integer
          readOnly: true
        name:
          description: Carrier name
          example: Cory Companies
          maxLength: 64
          minLength: 1
          type: string
        code:
          description: Carrier code
          example: CJCD
          maxLength: 64
          minLength: 1
          type: string
    RetailerMini:
      required:
        - code
        - name
      type: object
      properties:
        id:
          description: Retailer ID
          example: 510
          type: integer
          readOnly: true
        code:
          description: >-
            Retailer code, which same as retailer name but in lower case and
            underscore
          example: hobie_store
          maxLength: 32
          minLength: 1
          pattern: ^[-a-zA-Z0-9_]+$
          type: string
          format: slug
        name:
          description: Retailer name
          example: Hobie Store
          maxLength: 64
          minLength: 1
          type: string
    BrandMini:
      required:
        - code
      type: object
      properties:
        id:
          description: Vendor ID
          example: 456
          type: integer
          readOnly: true
        code:
          description: Vendor code. Same as vendor name in lower case and hyphenated
          example: marla-store
          maxLength: 64
          minLength: 1
          pattern: ^[-a-zA-Z0-9_]+$
          type: string
          format: slug
        name:
          description: Vendor name
          example: Marla Store
          maxLength: 64
          minLength: 1
          type: string
    CancelLine:
      type: object
      properties:
        id:
          description: Cancel line ID
          example: 7898
          type: integer
          readOnly: true
        variant:
          description: Variant name
          example: Var1
          type: string
          readOnly: true
        quantity:
          description: Variant quantity
          example: 3
          maximum: 2147483647
          minimum: -2147483648
          type: integer
        estimated_availability_date:
          description: Estimated availability date of variant
          example: 12-12-2022
          type: string
          format: date
          nullable: true
    ShippingAccount:
      required:
        - nickname
      type: object
      properties:
        id:
          description: Shipping account ID
          example: 3
          type: integer
          readOnly: true
        nickname:
          description: Nickname of shipping account
          example: Hobie FedEx
          maxLength: 64
          minLength: 1
          type: string
        owner:
          description: Owner of shipping account
          example: Sample Owner
          type: string
          readOnly: true
        carrier:
          $ref: '#/components/schemas/Carrier'
        is_first_party_bill:
          description: 'true: is first party billed shipment | false Is not first party bill'
          example: true
          type: boolean
    Tracking:
      type: object
      properties:
        picked_up_at:
          description: Time of order pickup
          example: '2022-08-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        delivered_at:
          description: Time of order delivery
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        tracking_details:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/TrackingDetail'
    ErrorLog:
      type: object
      properties:
        id:
          description: Error log ID
          example: 677
          type: integer
          readOnly: true
        message:
          description: Message in error log
          example: Sample errors to fix
          type: string
          nullable: true
        count:
          description: Count of error log
          example: 12
          type: integer
          readOnly: true
        created_at:
          description: Time of error log creation
          example: '2022-08-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    RetailerShipmentLine:
      type: object
      properties:
        id:
          description: Shipment line ID
          example: 1001
          type: integer
          readOnly: true
        order_line_number:
          description: Order line number
          example: '1001'
          type: string
          readOnly: true
        quantity:
          description: Order quantity
          example: 1
          maximum: 2147483647
          minimum: -2147483648
          type: integer
        part:
          description: Internal only
          example: 1
          maximum: 2147483647
          minimum: -2147483648
          type: integer
        freight_class:
          description: Freight class
          example: 50
          type: string
          nullable: true
          enum:
            - '50'
            - '55'
            - '60'
            - '65'
            - '70'
            - '77.5'
            - '85'
            - '92.5'
            - '100'
            - '110'
            - '125'
            - '150'
            - '175'
            - '200'
            - '250'
            - '300'
            - '400'
            - '500'
        updated_at:
          description: Time of last update
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        variant:
          $ref: '#/components/schemas/VariantMini'
    AttachmentTag:
      required:
        - tag
      type: object
      properties:
        id:
          description: Attachment tag ID
          example: 432
          type: integer
          readOnly: true
        tag:
          description: attachment tag
          example: demotag
          maxLength: 128
          minLength: 1
          type: string
    InvoiceAllowance:
      required:
        - description
        - price
      type: object
      properties:
        id:
          description: Allowance ID
          example: 1
          type: integer
          readOnly: true
        adjustment_code:
          $ref: '#/components/schemas/AdjustmentCode'
        description:
          description: Description of allowance
          example: Sample-discount-allowance
          maxLength: 128
          minLength: 1
          type: string
        price:
          description: Allowance price
          example: '12.10'
          type: string
          format: decimal
    InvoiceCharge:
      required:
        - description
        - price
      type: object
      properties:
        id:
          description: Invoice ID
          example: 654
          type: integer
          readOnly: true
        adjustment_code:
          $ref: '#/components/schemas/AdjustmentCode'
        description:
          description: Invoice description
          example: Sample invoice and its description
          maxLength: 128
          minLength: 1
          type: string
        price:
          description: Invoice price
          example: '23.45'
          type: string
          format: decimal
    InvoiceLine:
      required:
        - price
        - quantity
      type: object
      properties:
        id:
          description: Invoice line ID
          example: 765
          type: integer
          readOnly: true
        variant:
          $ref: '#/components/schemas/VariantShort'
        invoice_line_number:
          description: Invoice line number
          example: 2
          maximum: 2147483647
          minimum: -2147483648
          type: integer
          nullable: true
        item_brand_identifier:
          description: Vendor identifier of product
          example: Vend134
          maxLength: 128
          type: string
          nullable: true
        item_upc:
          description: >-
            Universal product code (UPC) is a 12-digit combination of numbers
            assigned to each product in your dropshipping store
          example: '911911911112'
          maxLength: 32
          type: string
          nullable: true
        quantity:
          description: Product quantity
          example: 45
          maximum: 2147483647
          minimum: -2147483648
          type: integer
        name:
          description: Product name
          example: SamPro1
          maxLength: 128
          type: string
          nullable: true
        description:
          description: Product description
          example: Sample description of product
          maxLength: 128
          type: string
          nullable: true
        canceled_at:
          description: Time of cancellation (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        price:
          description: Discounted price
          example: '12.00'
          type: string
          format: decimal
        retail_price:
          description: Retail price
          example: '14.00'
          type: string
          format: decimal
          readOnly: true
    InvoiceAcceptance:
      type: object
      properties:
        id:
          description: Invoice acceptance ID
          example: 565
          type: integer
          readOnly: true
        accepted_by:
          $ref: '#/components/schemas/UserShort'
          description: Vendor acceptance
        rejected_by:
          $ref: '#/components/schemas/UserShort'
        reject_reason:
          description: Reason for invoice rejection
          example: Incorrect
          maxLength: 128
          type: string
          nullable: true
        accepted_at:
          description: Time of invoice acceptance (UTC format)
          example: '2022-08-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        rejected_at:
          description: Time of invoice rejection (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
    RMALine:
      type: object
      properties:
        id:
          description: RMA line ID
          example: 567
          type: integer
          readOnly: true
        variant:
          $ref: '#/components/schemas/VariantShort'
        quantity:
          description: Total quantity
          example: 20
          maximum: 2147483647
          minimum: -2147483648
          type: integer
        quantity_shipped:
          description: Quantity shipped
          example: 10
          type: integer
          readOnly: true
        net_price:
          description: Net price
          example: '12.00'
          type: string
          readOnly: true
    CreditLine:
      required:
        - quantity
      type: object
      properties:
        id:
          description: Credit line ID
          example: 566
          type: integer
          readOnly: true
        variant:
          $ref: '#/components/schemas/VariantShort'
        quantity:
          description: Quantity
          example: 10
          maximum: 2147483647
          minimum: -2147483648
          type: integer
        net_price:
          description: Credit line net price
          example: '12.99'
          type: string
          format: decimal
    Adjustment:
      type: object
      properties:
        id:
          description: Adjustment ID
          example: 566
          type: integer
          readOnly: true
        description:
          description: Adjustment description
          example: Sample description for adjustment
          maxLength: 128
          type: string
          nullable: true
        net_price:
          description: Adjustment net price
          example: '1.00'
          type: string
          format: decimal
    ConnectionShort:
      type: object
      properties:
        id:
          description: Connection ID
          example: '1001'
          type: integer
          readOnly: true
        brand:
          $ref: '#/components/schemas/BrandShort'
        retailer:
          $ref: '#/components/schemas/RetailerShort'
        status:
          description: Connection status
          example: active
          type: string
          enum:
            - active
            - suspended
            - pending
            - onboarding
        created_at:
          description: Time of connection creation
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        level:
          description: Connection type
          example: full
          type: string
          enum:
            - basic
            - full
        options:
          $ref: '#/components/schemas/ConnectionOption'
        metadata:
          description: Metadata
          example: About us
          type: string
          readOnly: true
        connection_adjustments:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/ConnectionAdjustment'
        integration_type:
          description: Integration type
          example: API
          type: string
          nullable: true
          enum:
            - console
            - edi
            - api
            - storefront
            - console-print-labels
            - console-register-tracking-numbers
            - shopify
            - bigcommerce
            - shipstation
        retailer_identifier:
          description: Variant identifier specific to retailer
          example: R566A
          maxLength: 32
          type: string
          nullable: true
    ShippingProviderAccount:
      type: object
      properties:
        id:
          description: Account ID of shipping provider
          example: 76546
          type: integer
          readOnly: true
        shipping_provider:
          $ref: '#/components/schemas/ShippingProvider'
        shipping_methods:
          $ref: '#/components/schemas/ShippingMethod'
        credential_values:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/CredentialValue'
        created_at:
          description: Time of account (UTC format)
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Time of account update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    EdiAccount:
      required:
        - identifier
        - secondary_identifier
      type: object
      properties:
        id:
          description: EDI account ID
          example: 2344
          type: integer
          readOnly: true
        status:
          description: EDI account status
          example: active
          type: string
          enum:
            - setup
            - testing
            - active
            - disabled
            - suspended
        retailer:
          $ref: '#/components/schemas/RetailerShort'
        brand:
          $ref: '#/components/schemas/BrandShort'
        identifier:
          description: Unique identifier of EDI account
          example: SKU1
          maxLength: 32
          minLength: 1
          type: string
        secondary_identifier:
          description: Secondary identifier of EDI account
          example: ACF1
          maxLength: 32
          type: string
          nullable: true
        qualifier:
          description: >-
            Type of identifier used by EDI account. 01 means EDI account is
            using DUNS number as identifier
          example: '01'
          type: string
          default: ZZ
          enum:
            - ZZ
            - '01'
            - '02'
            - '08'
            - '09'
            - '12'
            - '13'
            - '14'
            - '15'
            - '16'
    Document:
      required:
        - transaction_set
        - transaction_set_control_number
      type: object
      properties:
        id:
          description: Document ID
          example: 254
          type: integer
          readOnly: true
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/Job'
        transaction_set:
          description: Transaction set
          example: '810'
          type: string
          enum:
            - '810'
            - '846'
            - '850'
            - '855'
            - '856'
            - '860'
            - '997'
        transaction_set_control_number:
          description: Transaction set control number related to EDI
          example: 456
          maximum: 4294967295
          minimum: 0
          type: integer
        accepted_at:
          description: Time of document acceptance (UTC format)
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        rejected_at:
          description: Time of document rejection (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
    EnvelopeEntity:
      required:
        - content_type
        - envelope
        - object_id
      type: object
      properties:
        id:
          description: Envelope entity ID
          example: 2145
          type: integer
          readOnly: true
        envelope:
          $ref: '#/components/schemas/Envelope'
        content_type:
          description: Content type
          example: PDF
          type: integer
        object_id:
          description: Object ID associated with the content type
          example: 666
          maximum: 4294967295
          minimum: 0
          type: integer
    TrackingDetail:
      required:
        - status
        - status_detail
        - Time
      type: object
      properties:
        id:
          description: Tracking ID
          example: 78895456
          type: integer
          readOnly: true
        Time:
          description: Time of tracking (UTC format)
          example: 10-10-2022
          type: string
          format: date-time
        status:
          description: Tracking status
          example: Delivered
          maxLength: 32
          minLength: 1
          type: string
        status_detail:
          description: Status details
          example: Out for delivery
          maxLength: 64
          minLength: 1
          type: string
        country:
          description: Country of delivery
          example: USA
          maxLength: 8
          type: string
          nullable: true
        state:
          description: State of delivery
          example: New york
          maxLength: 8
          type: string
          nullable: true
        city:
          description: City of delivery
          example: New york
          maxLength: 32
          type: string
          nullable: true
        postal_code:
          description: Postal code for delivery
          example: 123R32
          maxLength: 16
          type: string
          nullable: true
    VariantMini:
      type: object
      properties:
        id:
          description: Variant ID
          example: 249
          type: integer
          readOnly: true
        name:
          description: Variant name
          example: Var45
          maxLength: 200
          type: string
          nullable: true
        brand:
          $ref: '#/components/schemas/BrandMini'
        identifier:
          description: Stock Keeping Unit (SKU), unique identifier of a product
          example: 123-DEF12345
          maxLength: 128
          type: string
          nullable: true
        brand_identifier:
          description: Brand identifier
          example: HATR
          minLength: 1
          type: string
          readOnly: true
        upc:
          description: >-
            Universal product code (UPC) is a 12-digit combination of numbers
            assigned to each product in your drop-shipping store
          example: 555555555202
          maxLength: 64
          type: string
        retailer_identifiers:
          type: array
          items:
            $ref: '#/components/schemas/RetailerIdentifier'
    AdjustmentCode:
      required:
        - adjustment_type
        - code
        - description
      type: object
      properties:
        id:
          description: Adjustment ID
          example: 1
          type: integer
          readOnly: true
        adjustment_type:
          description: Adjustment type
          example: Allowance
          type: string
          enum:
            - allowance
            - charge
        code:
          description: Adjustment code
          example: returns_allowance
          maxLength: 64
          minLength: 1
          type: string
        description:
          description: Description of adjustment
          example: returns_allowance
          maxLength: 128
          minLength: 1
          type: string
    VariantShort:
      type: object
      properties:
        id:
          description: Variant ID
          example: 100024
          type: integer
          readOnly: true
        name:
          description: Variant Name
          example: T-Shirt, Blue, L
          maxLength: 200
          type: string
          nullable: true
        brand:
          $ref: '#/components/schemas/BrandShort'
        brand_identifier:
          description: Unique SKU assigned by the Brand
          example: 1000-BL-L
          minLength: 1
          type: string
          readOnly: true
        identifier:
          description: >-
            Identifier assigned by the retailer (if set). Otherwise, returns the
            unique SKU assigned by the Brand.
          example: '5000001'
          maxLength: 128
          type: string
          nullable: true
        upc:
          description: UPC or other GTIN
          example: 9119119111
          maxLength: 64
          type: string
        cartons:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Carton'
        color:
          description: Color of the item (from attributes.color)
          example: Red
          maxLength: 128
          type: string
          nullable: true
        style:
          description: Style of the item (will be the same value as attributes.style)
          example: Print
          maxLength: 128
          type: string
          nullable: true
        size:
          description: Size of the item (will be the same value as attributes.size)
          example: Large
          maxLength: 128
          type: string
          nullable: true
        media:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/VariantImage'
        attributes:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Attribute'
        ruleset_variants:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/RulesetVariant'
        ruleset_variant_summary:
          description: Number of items that are passed and failed in rule validation.
          example: '21'
          type: string
          readOnly: true
        active_permit:
          $ref: '#/components/schemas/Permit'
        permits:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Permit'
        is_compatible:
          description: >-
            true: variant meets requirement | false: variant doesn not meet
            requirement
          example: true
          type: boolean
          readOnly: true
        proposal_variant:
          $ref: '#/components/schemas/ProposalVariant'
        retailer_identifiers:
          $ref: '#/components/schemas/RetailerIdentifier'
        retailer_categories:
          $ref: '#/components/schemas/RetailerCategory'
        inventory:
          $ref: '#/components/schemas/InventoryBase'
    ConnectionOption:
      required:
        - code
        - name
      type: object
      properties:
        id:
          description: Option ID
          example: 8753
          type: integer
          readOnly: true
        name:
          description: Option name
          example: Sample Option
          maxLength: 64
          minLength: 1
          type: string
        code:
          description: Option code
          example: Sample_Option
          maxLength: 64
          minLength: 1
          type: string
        description:
          description: Connection description
          example: Sample description for connection
          type: string
          nullable: true
        viewable_by:
          description: User who can view the connection details
          example: All
          type: string
          nullable: true
          enum:
            - retailer
            - brand
            - all
            - none
        editable_by:
          description: User who can edit connection
          example: Staff
          type: string
          nullable: true
          enum:
            - retailer
            - brand
            - staff
    ConnectionAdjustment:
      required:
        - description
      type: object
      properties:
        id:
          description: Connection adjustment ID, used for monetary adjustments
          example: 123442
          type: integer
          readOnly: true
        adjustment_code:
          $ref: '#/components/schemas/AdjustmentCode'
        description:
          description: Description of adjustment
          example: Sample description for monetary adjustments
          maxLength: 256
          minLength: 1
          type: string
        adjustment_type:
          description: Adjustment type
          example: Discount
          type: string
          readOnly: true
        adjustment_amount_type:
          description: Adjustment type - dollar amount or percentage
          example: flat
          type: string
          enum:
            - percent
            - flat
        adjustment_amount:
          description: Adjustment amount
          example: '12'
          type: string
          format: decimal
        content_type:
          description: Content type
          example: PDF
          minLength: 1
          type: string
          readOnly: true
        object_id:
          description: Object ID
          example: 45646
          maximum: 4294967295
          minimum: 0
          type: integer
          nullable: true
    ShippingProvider:
      type: object
      properties:
        id:
          description: Shipping provider ID
          example: 2455
          type: integer
          readOnly: true
        name:
          description: Name of shipping provider
          example: Sample shipping provider
          maxLength: 32
          type: string
          nullable: true
        credentials:
          description: Credentials for shipping provider
          type: string
          readOnly: true
        shipping_methods:
          description: Shipping methods
          example: Next day delivery
          type: string
          readOnly: true
        created_at:
          description: Time of shipping provider creation (UTC format)
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Time of shipping provider update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    CredentialValue:
      type: object
      properties:
        id:
          description: Credentials ID
          example: 165
          type: integer
          readOnly: true
        credential:
          $ref: '#/components/schemas/Credential'
        value:
          description: Credentials value
          type: string
          readOnly: true
        created_at:
          description: Time of credentials creation (UTC format)
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Time of credentials update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    Job:
      type: object
      required:
        - content_type
        - object_id
        - runtime_id
        - module_name
      properties:
        id:
          description: Job ID
          type: integer
          readOnly: true
        content_type:
          description: Content type
          example: 1
          type: integer
        object_id:
          description: Object ID
          type: integer
          maximum: 4294967295
          minimum: 0
          example: 145
        connection:
          $ref: '#/components/schemas/ConnectionShort'
        runtime_id:
          description: Runtime ID
          type: string
          maxLength: 64
          minLength: 1
        module_name:
          description: Module name
          type: string
          maxLength: 64
          minLength: 1
          example: demo module
        created_at:
          description: Time of job creation (UTC format)
          type: string
          format: date-time
          readOnly: true
          example: '2022-08-10T15:24:56Z'
        start_time:
          description: Time of job beginning (UTC format)
          type: string
          readOnly: true
          example: '2022-11-10T15:24:56Z'
        finish_time:
          description: Time of job ending (UTC format)
          type: string
          readOnly: true
          example: '2022-11-10T15:24:56Z'
        description:
          description: Brief description of the job, for future reference.
          type: string
          readOnly: true
        total_success:
          description: Successful completion of job
          type: string
          readOnly: true
        total_failure:
          description: Unsuccessful completion of job
          type: string
          readOnly: true
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/Metadata'
          readOnly: true
        error_count:
          description: Error count
          type: string
          readOnly: true
        error_logs:
          $ref: '#/components/schemas/ErrorLog'
    RetailerIdentifier:
      type: object
      properties:
        id:
          description: Retailer ID
          example: 5642
          type: integer
          readOnly: true
        retailer:
          $ref: '#/components/schemas/RetailerShort'
        identifier:
          description: Stock Keeping Unit (SKU), unique identifier of a product
          example: SKU976
          maxLength: 256
          type: string
          nullable: true
        name:
          description: Retailer name
          example: Retailer Sample
          maxLength: 256
          type: string
          nullable: true
    Carton:
      type: object
      properties:
        id:
          description: Carton ID
          example: 48
          type: integer
          readOnly: true
        number:
          description: Carton number
          example: 1
          maximum: 2147483647
          minimum: -2147483648
          type: integer
        length:
          description: Carton length
          example: '1'
          type: string
          format: decimal
          nullable: true
        length_unit:
          description: Unit of length
          example: '1'
          type: string
          readOnly: true
        width:
          description: Carton width
          example: '1'
          type: string
          format: decimal
          nullable: true
        width_unit:
          description: Unit of width
          example: meter
          type: string
          readOnly: true
        height:
          description: Carton height
          example: '1'
          type: string
          format: decimal
          nullable: true
        height_unit:
          description: Unit of height
          example: meter
          type: string
          readOnly: true
        weight:
          description: Carton weight
          example: '15'
          type: string
          format: decimal
          nullable: true
        weight_unit:
          description: Unit of weight
          example: KG
          type: string
          readOnly: true
        package_girth_inches:
          description: Girth of the package, in inches
          example: '1'
          type: string
          readOnly: true
        package_size_inches:
          description: Size of the package, in inches
          example: '1'
          type: string
          readOnly: true
    VariantImage:
      type: object
      properties:
        id:
          description: Variant ID
          example: 249
          type: integer
          readOnly: true
        width:
          description: Width of variant image
          example: 100
          maximum: 2147483647
          minimum: -2147483648
          type: integer
          nullable: true
        height:
          description: Height of variant image
          example: 100
          maximum: 2147483647
          minimum: -2147483648
          type: integer
          nullable: true
        media:
          description: Variant images
          example: default
          type: string
          readOnly: true
        priority:
          description: >-
            Order in which the vendor prefers the images to be shown image 1 is
            shown first.
          example: 1
          maximum: 2147483647
          minimum: -2147483648
          type: integer
        url:
          description: URL of variant image
          example: 192.168.99.100/media/default/original
          type: string
          readOnly: true
        updated_at:
          description: Time of variant image update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        created_at:
          description: Time of variant image creation (UTC format)
          example: '2022-08-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    Attribute:
      required:
        - code
        - name
        - type
      type: object
      properties:
        id:
          description: Attribute ID
          example: 44
          type: integer
          readOnly: true
        code:
          description: Attribute code
          example: size
          maxLength: 200
          minLength: 1
          type: string
        name:
          description: Attribute name
          example: Size
          maxLength: 200
          minLength: 1
          type: string
        editable_by:
          description: User permission to edit attribute
          example: brand
          type: string
          nullable: true
          enum:
            - retailer
            - brand
            - any
            - none
        grouping:
          description: Criteria to group attribute
          example: general
          type: string
          nullable: true
          enum:
            - description
            - general
            - images
            - inventory
            - misc
            - retailer
            - shipping
            - identifiers
            - pricing
        description:
          description: Attribute description
          example: demo product description
          type: string
          nullable: true
        type:
          description: Attribute type
          example: money
          type: string
          enum:
            - boolean
            - date
            - list
            - media
            - money
            - number
            - percent
            - string
            - text
            - url
        units:
          description: >-
            Unit of the selected attribute **type**. If the attribute type is
            money, the unit is USD.
          example: USD
          maxLength: 32
          type: string
          nullable: true
        values:
          $ref: '#/components/schemas/AttributeValue'
    RulesetVariant:
      type: object
      properties:
        id:
          description: ID of ruleset variant
          example: 1232
          type: integer
          readOnly: true
        status:
          description: Status of ruleset variant
          example: processing
          type: string
          enum:
            - processing
            - passed
            - failed
        ruleset:
          $ref: '#/components/schemas/RulesetVariant'
        results:
          description: Response
          type: string
        created_at:
          description: Time of creation (UTC format)
          example: '2022-08-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Time of last update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    Permit:
      type: object
      properties:
        id:
          description: Permit ID
          example: 10104
          type: integer
          readOnly: true
        retailer:
          $ref: '#/components/schemas/RetailerShort'
        retailer_price:
          description: Retailer price of the variant
          example: '12.99'
          type: string
          format: decimal
          nullable: true
        retailer_cost:
          description: Retailer cost of variant
          example: '8.99'
          type: string
          format: decimal
          nullable: true
        pricing:
          type: object
          properties: {}
        attributes:
          type: object
          properties: {}
        start_at:
          description: Time of permit start (UTC format)
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        end_at:
          description: Time of permit end (UTC format)
          example: '2024-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        is_in_effect:
          description: 'true: permit is in effect | false: permit is not in effect'
          example: true
          type: boolean
          readOnly: true
        revoked_at:
          description: Time when permit got revoked (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        is_acknowledged:
          description: 'true: permit is acknowledged | false: permit is not acknowledged'
          example: true
          type: boolean
          readOnly: true
        acknowledged_at:
          description: Time of acknowledgement (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
    ProposalVariant:
      type: object
      properties:
        id:
          description: Proposal variant ID
          example: 3456
          type: integer
          readOnly: true
        pricing:
          description: Pricing of variant
          example: '12.00'
          type: string
          readOnly: true
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/AttributeValue'
        memos:
          type: array
          items:
            $ref: '#/components/schemas/Memo'
        issues:
          type: array
          items:
            $ref: '#/components/schemas/IssueElementOnly'
          readOnly: true
        variant_id:
          description: Variant ID
          example: 249
          type: integer
          readOnly: true
        approved_at:
          description: Time of approval (UTC format)
          example: '2022-10-10T15:24:56Z'
          type: string
          format: date-time
          nullable: true
        created_at:
          description: Time of creation (UTC format)
          example: '2022-07-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Time of last update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        rejected_at:
          description: Time of proposal rejection (UTC format)
          example: null
          type: string
          format: date-time
          nullable: true
        reject_reason:
          description: Rejection reason
          example: Incomplete
          maxLength: 32
          type: string
          nullable: true
        reject:
          description: 'true: proposal is rejected | false: proposal is not rejected'
          example: true
          type: boolean
        approve:
          description: 'true: proposal is approved | false: proposal is not approved'
          example: false
          type: boolean
        delete:
          description: 'true: proposal is deleted | false: proposal is not deleted'
          example: false
          type: boolean
    RetailerCategory:
      required:
        - category
      type: object
      properties:
        id:
          description: Retailer category ID
          example: 453
          type: integer
          readOnly: true
        retailer:
          $ref: '#/components/schemas/RetailerShort'
        category:
          description: Category name
          example: CategoryANC
          maxLength: 256
          minLength: 1
          type: string
    InventoryBase:
      required:
        - brand_inventory_updated_at
        - estimated_availability_date
        - inventory_last_submitted_at
        - inventory_updated_at
        - sellable_updated_at
      type: object
      properties:
        discontinued:
          description: 'true: Product is discontinued | false: Product is active'
          example: true
          type: boolean
          readOnly: true
        discontinued_updated_at:
          description: Time of when product inventory was discontinued (UTC format)
          example: null
          type: string
          format: date-time
          readOnly: true
        inventory:
          description: Inventory of variant
          example: 0
          type: integer
          readOnly: true
        inventory_updated_at:
          description: Time of inventory update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
        inventory_last_submitted_at:
          description: Time of inventory submit (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
        brand_inventory_updated_at:
          description: Time of vendor inventory update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
        sellable:
          description: 'yes: Variant is sellable | No: Variant is not sellable'
          example: 'No'
          type: string
          readOnly: true
        sellable_updated_at:
          description: Time when product or variant was marked sellable (UTC format)
          example: '2022-11-10T15:24:56Z'
          type: string
          format: date-time
        replenishable:
          description: 'true: product is replenishable | false: product is not replenishable'
          example: true
          type: boolean
          readOnly: true
        estimated_availability_date:
          description: Estimated delivery date (UTC format)
          example: '2022-09-10T15:24:56Z'
          minLength: 1
          type: string
        locations:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/InventoryLocation'
    Credential:
      required:
        - code
        - data_type
        - name
      type: object
      properties:
        id:
          description: Credentials ID
          example: 656
          type: integer
          readOnly: true
        code:
          description: Credentials code
          example: cred_sample
          maxLength: 64
          minLength: 1
          type: string
        name:
          description: Credentials code
          example: Cred Sample
          maxLength: 64
          minLength: 1
          type: string
        data_type:
          description: Data type of credentials
          example: text
          type: string
          enum:
            - text
            - boolean
        is_required:
          description: '1: Credentials are required | 0: Credentials are not required'
          example: 1
          maximum: 2147483647
          minimum: -2147483648
          type: integer
        is_encrypted:
          description: '1: Credentials are encrypted | 0: Credentials are not encrypted'
          example: 1
          maximum: 2147483647
          minimum: -2147483648
          type: integer
        created_at:
          description: Time of credentials creation (UTC format)
          example: '2021-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Time of credentials update (UTC format)
          example: '2022-09-10T15:24:56Z'
          type: string
          format: date-time
          readOnly: true
    Metadata:
      type: object
      properties: {}
    AttributeValue:
      type: object
      properties:
        id:
          description: Attribute value ID
          type: integer
          readOnly: true
        value:
          description: Attribute value
          type: string
          x-nullable: true
        unit:
          $ref: '#/components/schemas/Unit'
        retailer:
          $ref: '#/components/schemas/RetailerShort'
        updated_at:
          description: Time of update
          type: string
          format: date-time
          x-nullable: true
        created_at:
          description: Time of creation
          type: string
          format: date-time
          readOnly: true
    IssueElementOnly:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
          description: Issue ID
        memos:
          type: array
          items:
            $ref: '#/components/schemas/Memo'
          readOnly: true
        created_at:
          description: Time of issue creation
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Time of issue update
          type: string
          format: date-time
          readOnly: true
        resolved_at:
          description: Time of issue resolution
          type: string
          format: date-time
          x-nullable: true
        is_resolved:
          description: 'true: Issue is resolved | false: Issue is not resolved'
          type: string
          readOnly: true
        issue_id:
          description: Issue ID
          type: integer
          readOnly: true
        message:
          description: Description or note related to issue
          type: string
          readOnly: true
          minLength: 1
        title:
          description: Issue title
          type: string
          readOnly: true
          minLength: 1
    InventoryLocation:
      type: object
      properties:
        id:
          description: Location ID
          example: 1
          type: integer
          readOnly: true
        address:
          $ref: '#/components/schemas/Address'
        inventory:
          description: Count of sellable variants
          example: 0
          type: integer
          readOnly: true
        nickname:
          description: Nickname of location
          example: LA Warehouse
          type: string
          readOnly: true
    Unit:
      type: object
      properties:
        id:
          description: Unit ID
          example: 677
          type: integer
          readOnly: true
        name:
          description: Unit name
          example: Sample unit
          minLength: 1
          type: string
          readOnly: true
        standard_unit:
          description: Standard unit
          minLength: 1
          type: string
          readOnly: true
        type:
          description: Unit type
          example: cost
          type: string
          readOnly: true
          enum:
            - area
            - distance
            - energy
            - speed
            - temperature
            - time
            - volume
            - weight
            - cost
        system:
          description: Unit system
          example: metric
          type: string
          nullable: true
          enum:
            - metric
            - imperial
        symbol:
          description: Unit symbol
          example: USD
          maxLength: 5
          type: string
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````