# List Orders

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /orders:
    get:
      summary: List Orders
      deprecated: false
      description: >+
        This endpoint allows you to list all orders related to your store.


        :::warning[List Orders Pagination Guidelines]


        To ensure reliable pagination results, follow these recommendations:


        - **Retrieve pages sequentially** (`page=1`, then `page=2`, `page=3`,
        and so on).

        - **Do not skip pages.** Requesting a page out of sequence (for example,
        jumping directly to `page=10`) will return an empty response.

        - **Use the maximum page size** by setting `per_page=30` to reduce the
        total number of requests.

        - **Complete pagination within 15 minutes.** Sequential page requests
        are cached for a **15-minute** window.

        - **Filter by date whenever possible.** Use the `from_date` and
        `to_date` query parameters to retrieve smaller datasets and improve
        pagination performance.


        :::


        :::danger[Breaking Change Notice]

        Effective 18th February 2026, the `groups` array under the `customer`
        object will be deprecated. Alternatively, you can use the [Customer
        Details Endpoint](https://docs.salla.dev/5394122e0) to get the groups
        assigned to a specific customer.

        :::


        :::danger[Deprecation Notice]

        - Starting **1st of September , 2026** the `expanded=true` query
        parameter will no longer be supported.

        - Apps created after **15th of August, 2024**  do not support the
        `expanded=true` query parameter. 

        - Apps created before **15th of August, 2024** will not be able to use
        the`expanded` response. `(Expires at 1st of September 2026)`

        :::



        :::tip[Note]

        • For old apps (expanded query parameter), the `shipping_details_id`
        inside the `shipping` object response matches the `id` returned by the
        [shipping estimated rate endpoint](https://docs.salla.dev/6899590e0).

        :::


        <Accordion title="Scopes" defaultOpen={true} icon="lucide-key-round">

        `orders.read` - Orders Read Only

        </Accordion>

      operationId: List-Orders
      tags:
        - Default module/Merchant API/APIs/Orders
        - Orders
      parameters:
        - name: keyword
          in: query
          description: >
            Listing the orders by keywords such as
            [tag_name](https://docs.salla.dev/api-5394180/?nav=1) and
            [shipping_number](https://docs.salla.dev/api-5394160/?nav=1)
          required: false
          example: ''
          schema:
            type: string
            enum:
              - customer.mobile
              - customer.name
              - shipping_number
              - reference_id
              - tag_name
            x-apidog-enum:
              - name: ''
                value: customer.mobile
                description: The customer phone number
              - name: ''
                value: customer.name
                description: 'The name of the customer '
              - name: ''
                value: shipping_number
                description: A number assigned to the shipping.
              - name: ''
                value: reference_id
                description: The unique identification number assigned to the order.
              - name: ''
                value: tag_name
                description: Tage name
        - name: payment_method
          in: query
          description: >-
            Find orders for specific payment method. List of available payment
            methods can be found
            [here](https://docs.salla.dev/api-5394164/?nav=1)
          required: false
          example: ''
          schema:
            type: array
            items:
              type: string
        - name: status
          in: query
          description: >-
            Find orders for specific status (array of ID integers). List of
            statuses can be found
            [here](https://docs.salla.dev/api-5394150/?nav=1)
          required: false
          example: ''
          schema:
            type: array
            items:
              type: string
        - name: from_date
          in: query
          description: Find orders created after a specific date.
          required: false
          example: ''
          schema:
            type: string
            format: date
            examples:
              - '2024-01-01'
            pattern: yyyy-mm-dd
        - name: to_date
          in: query
          description: Find orders created before a specific date.
          required: false
          example: ''
          schema:
            type: string
            pattern: yyyy-mm-dd
            format: date
            examples:
              - '2024-01-02'
        - name: country
          in: query
          description: >-
            Find orders for specific country. List of countries can be found
            [here](https://docs.salla.dev/api-5394228/?nav=1)
          required: false
          example: 0
          schema:
            type: integer
        - name: city
          in: query
          description: >-
            Find orders for specific city. List of cities can be found
            [here](https://docs.salla.dev/api-5394230/?nav=1)
          required: false
          example: ''
          schema:
            type: string
            examples:
              - jeddah
        - name: product
          in: query
          description: >-
            Find orders for specific product via its `name` variable. List of
            products can be found
            [here](https://docs.salla.dev/api-5394168/?nav=1)
          required: false
          example: ''
          schema:
            type: string
        - name: branch
          in: query
          description: >-
            Find orders for specific branch (array of integers). List of
            branches can be found
            [here](https://docs.salla.dev/api-5394224/?nav=1)
          required: false
          example: ''
          schema:
            type: array
            items:
              type: string
        - name: tags
          in: query
          description: >-
            Find orders for specific tags (array of ID integers). List of tags
            can be found [here](https://docs.salla.dev/api-5394154/?nav=1)
          required: false
          example: ''
          schema:
            type: array
            items:
              type: string
        - name: expanded
          in: query
          description: >-
            Get full details of orders same as [order
            details](https://docs.salla.dev/api-5394147/?nav=1) response by
            setting the value to `true`.
          required: false
          example: ''
          schema:
            type: boolean
            deprecated: true
          deprecated: true
        - name: page
          in: query
          description: The Pagination page number
          required: false
          example: 0
          schema:
            type: integer
        - name: reference_id
          in: query
          description: >-
            Unique identification refrence number that appears to the store
            owner
          required: false
          example: 0
          schema:
            type: integer
        - name: coupon
          in: query
          description: Discount code, extracted from `discount.code`
          required: false
          example: ''
          schema:
            type: string
        - name: customer_id
          in: query
          description: Customer unique identification number.
          required: false
          example: 0
          schema:
            type: number
        - name: shipping_app_id
          in: query
          description: Number array of Shipping Application unique identification number.
          required: false
          example: ''
          schema:
            type: array
            items:
              type: string
        - name: source
          in: query
          description: Order source.
          required: false
          example: ''
          schema:
            type: array
            items:
              type: string
        - name: sort_by
          in: query
          description: >-
            Sort the retrieved orders based on one attribute from the enum
            values. For example, if we need to sort the order by the `id` in
            ascending or descending order. we will concatenate either `asc` or
            `desc` with one of the enum values; in this case, we will use
            `id-asc` or `id-desc`.
          required: false
          example: ''
          schema:
            type: string
            enum:
              - id
              - total
              - updated_at
              - created_at
            x-apidog-enum:
              - name: ''
                value: id
                description: Order id
              - name: ''
                value: total
                description: Order total
              - name: ''
                value: updated_at
                description: The date of updating the order
              - name: ''
                value: created_at
                description: The date of creating the order
        - name: accounting_services
          in: query
          description: >-
            To filter the orders that did not get sent to the accounting
            services.
          required: false
          example: ''
          schema:
            type: string
            enum:
              - qoyod
              - daftra
              - zoho_books
            x-apidog-enum:
              - name: ''
                value: qoyod
                description: ''
              - name: ''
                value: daftra
                description: ''
              - name: ''
                value: zoho_books
                description: ''
        - name: unread
          in: query
          description: Find the unread orders that merchant did not open yet.
          required: false
          example: ''
          schema:
            type: boolean
        - name: assign_employee
          in: query
          description: >-
            Find the orders that are assigned to one or more employees. List of
            employees can be found
            [here](https://docs.salla.dev/api-5394259/?nav=1)
          required: false
          example: ''
          schema:
            type: array
            items:
              type: string
        - name: selling_channel
          in: query
          description: >-
            The order-selling channel which can be one of the allowed enum
            values
          required: false
          example: ''
          schema:
            type: array
            items:
              type: string
              enum:
                - mobile
                - mobile-app
                - desktop
                - affiliate
                - mahly-app
        - name: created_by
          in: query
          description: >-
            Employee unique identification number who created the order(s). List
            of employees can be found
            [here](https://docs.salla.dev/api-5394259/?nav=1)
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_orders_response_body'
              examples:
                '1':
                  summary: Example
                  value:
                    status: 200
                    success: true
                    data:
                      - id: 1333249299
                        external_reference_id: null
                        reference_id: 275839672
                        urls:
                          customer: >-
                            https://salla.sa/test_domin22may/account/orders/yDKpAjR
                          admin: >-
                            https://s.salla.sa/orders/order/kDXv9mr2bGzYaey9dKKzaKoPexnAwyl0
                        total:
                          amount: 16.39
                          currency: SAR
                        exchange_rate:
                          base_currency: SAR
                          exchange_currency: SAR
                          rate: '1.00000000'
                        scope_exchange_rate: null
                        date:
                          date: '2026-08-02 18:08:47.000000'
                          timezone_type: 3
                          timezone: Asia/Riyadh
                        source: store
                        status:
                          id: 1939592358
                          name: قيد التنفيذ
                          slug: in_progress
                          customized:
                            id: 923207662
                            name: قيد التنفيذ
                        draft: false
                        read: true
                        can_cancel: false
                        can_reorder: false
                        payment_method: credit_card
                        payment_methods:
                          - amount: '10.93'
                            payment_method: bank
                            transaction_reference: null
                          - amount: '5.46'
                            payment_method: credit_card
                            transaction_reference: '9682442091042222'
                        is_pending_payment: false
                        pending_payment_ends_at: 0
                        is_overweighted: false
                        features:
                          shippable: true
                          is_international: false
                          internationally_shippable: false
                          digitalable: true
                          pickable: false
                          has_suspicious_alert: false
                          bullet_delivery:
                            is_bullet_delivery: false
                            bullet_countdown: 0
                            on_demand_countdown: 0
                            on_demand_delivery: false
                            on_demand_timer: false
                        gateway: null
                        payment_actions:
                          refund_action:
                            refunded_transactions: []
                            pending_refund_amount: null
                            has_refund_amount: false
                            payment_method_label: البطاقة الإئتمانية
                            can_print_refund_invoice: false
                            paid_amount:
                              amount: 16.39
                              currency: SAR
                            refund_amount:
                              amount: 0
                              currency: SAR
                            loyalty_point_programs: []
                            can_send_sms: true
                            can_send_sms_msg: يرجى تفعيل احد مزودين خدمة SMS من صفحة ربط الخدمات
                            can_refund_loyalty_prize_points: false
                            can_restore_loyalty_buy_from_store_points: false
                            can_refund_to_wallet: true
                          remaining_action:
                            has_remaining_amount: false
                            payment_method_label: البطاقة الإئتمانية
                            paid_amount:
                              amount: 16.39
                              currency: SAR
                            checkout_url: ''
                            remaining_amount:
                              amount: 0
                              currency: SAR
                        items:
                          - name: Perfumes Package
                            quantity: 1
                            thumbnail: >-
                              https://cdn.salla.sa/oEGE/products/03zlnFLaLzY0GtowFR5RRLY566vJYzqHJpYB7ggg.png
                          - name: Dress
                            quantity: 1
                            thumbnail: null
                        customer:
                          id: 19946325555
                          full_name: Mohammed Ahmed
                          first_name: Mohammed
                          last_name: Ahmed
                          mobile: 557777777
                          mobile_code: '+966'
                          email: test-email@gmail.com
                          urls:
                            customer: >-
                              https://demostore.salla.sa/dev-qemdv5vldnohhhpq/account/profile
                            admin: >-
                              https://s.salla.sa/customers/zAB3exRyLdXv5Wpk5lDarGg4p7Ej8ZKl
                          avatar: >-
                            https://cdn.assets.salla.network/prod/admin/cp/assets/images/avatar_female.png
                          gender: female
                          birthday:
                            date: '1987-08-12 00:00:00.000000'
                            timezone_type: 3
                            timezone: Asia/Riyadh
                          city: الحميمة
                          country: السعودية
                          country_code: SA
                          currency: SAR
                          location: ''
                          lang: ar
                          created_at:
                            date: '2025-12-25 12:41:10.000000'
                            timezone_type: 3
                            timezone: Asia/Riyadh
                          updated_at:
                            date: '2026-08-23 17:02:59.000000'
                            timezone_type: 3
                            timezone: Asia/Riyadh
                          type: user
                          groups: []
                      - id: 19238428888
                        external_reference_id: null
                        reference_id: 281659564
                        urls:
                          customer: https://salla.sa/test_domin22may/account/orders/Prr
                          admin: >-
                            https://s.salla.sa/orders/order/4GV9LQN3veZl1PZ5vVl9WBR6rJ5kzEoo
                        total:
                          amount: 104.15
                          currency: SAR
                        exchange_rate:
                          base_currency: SAR
                          exchange_currency: SAR
                          rate: '1.00000000'
                        scope_exchange_rate: null
                        date:
                          date: '2026-08-31 17:04:00.000000'
                          timezone_type: 3
                          timezone: Asia/Riyadh
                        source: store
                        status:
                          id: 566146469
                          name: بإنتظار المراجعة
                          slug: under_review
                          customized:
                            id: 1698363629
                            name: بإنتظار المراجعة
                        draft: false
                        read: true
                        can_cancel: false
                        can_reorder: false
                        payment_method: cod
                        payment_methods:
                          - amount: 0
                            payment_method: cod
                            transaction_reference: null
                        is_pending_payment: false
                        pending_payment_ends_at: 0
                        is_overweighted: false
                        features:
                          shippable: true
                          is_international: false
                          internationally_shippable: false
                          digitalable: false
                          pickable: false
                          has_suspicious_alert: false
                          bullet_delivery:
                            is_bullet_delivery: false
                            bullet_countdown: 0
                            on_demand_countdown: 0
                            on_demand_delivery: false
                            on_demand_timer: false
                        gateway: null
                        payment_actions:
                          refund_action:
                            refunded_transactions: []
                            pending_refund_amount: null
                            has_refund_amount: false
                            payment_method_label: دفع عند التسليم
                            can_print_refund_invoice: false
                            paid_amount:
                              amount: 0
                              currency: SAR
                            refund_amount:
                              amount: 0
                              currency: SAR
                            loyalty_point_programs: []
                            can_send_sms: true
                            can_send_sms_msg: ''
                            can_refund_loyalty_prize_points: false
                            can_restore_loyalty_buy_from_store_points: false
                            can_refund_to_wallet: true
                          remaining_action:
                            has_remaining_amount: false
                            payment_method_label: دفع عند التسليم
                            paid_amount:
                              amount: 0
                              currency: SAR
                            checkout_url: ''
                            remaining_amount: null
                        items:
                          - name: ورد احمر
                            quantity: 1
                            thumbnail: >-
                              https://cdn.salla.sa/oEGE/938c1b33-d877-4018-abe6-b5cbd765ad83-500x374.51737451737-ib1mUOvL3lq1zccCQiAnPrRsJ23KshubeO2eDKOS.jpg
                        customer:
                          id: 1994632555
                          full_name: Samer Ahmed
                          first_name: Samer
                          last_name: Ahmed
                          mobile: 553333333
                          mobile_code: '+966'
                          email: test-email3@gmail.com
                          urls:
                            customer: >-
                              https://demostore.salla.sa/dev-qemdv5vldnohhhpq/account/profile
                            admin: >-
                              https://s.salla.sa/customers/zAB3exRyLdXv5Wpk5lDarGg4p7Ej8ZKl
                          avatar: >-
                            https://cdn.assets.salla.network/prod/admin/cp/assets/images/avatar_female.png
                          gender: female
                          birthday:
                            date: '1987-08-12 00:00:00.000000'
                            timezone_type: 3
                            timezone: Asia/Riyadh
                          city: الحميمة
                          country: السعودية
                          country_code: SA
                          currency: SAR
                          location: ''
                          lang: ar
                          created_at:
                            date: '2025-12-25 12:41:10.000000'
                            timezone_type: 3
                            timezone: Asia/Riyadh
                          updated_at:
                            date: '2026-08-23 17:02:59.000000'
                            timezone_type: 3
                            timezone: Asia/Riyadh
                          type: user
                          groups: []
                    pagination:
                      count: 2
                      total: 1216
                      perPage: 2
                      currentPage: 1
                      totalPages: 608
                      links:
                        next: http://api.salla.dev/admin/v2/orders?per_page=2&page=2
                '2':
                  summary: Unauthorized
                  value:
                    status: 401
                    success: false
                    error:
                      code: Unauthorized
                      message: >-
                        The access token should have access to one of those
                        scopes: orders.read
          headers: {}
          x-apidog-name: 'Success '
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_unauthorized_401'
          headers: {}
          x-apidog-name: Unauthorized
      security:
        - bearer: []
      x-salla-php-method-name: list
      x-salla-php-return-type: ListOrders
      x-salla-php-return-base-type: array
      x-apidog-folder: Default module/Merchant API/APIs/Orders
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/451700/apis/api-5394146-run
components:
  schemas:
    get_orders_response_body:
      type: object
      properties:
        status:
          type: number
          description: >-
            Response status code, a numeric or alphanumeric identifier used to
            convey the outcome or status of a request, operation, or transaction
            in various systems and applications, typically indicating whether
            the action was successful, encountered an error, or resulted in a
            specific condition.
        success:
          type: boolean
          description: >-
            Response flag, boolean indicator used to signal a particular
            condition or state in the response of a system or application, often
            representing the presence or absence of certain conditions or
            outcomes.
        data:
          type: array
          x-stoplight:
            id: orurptuq9pvoy
          items:
            $ref: '#/components/schemas/ListOrders'
          description: >-
            Detailed structure of the List Order model object showing its fields
            and data types.
        pagination:
          description: >-
            For a better response behavior as well as maintain the best security
            level, All retrieving API endpoints use a mechanism to retrieve data
            in chunks called pagination. Pagination working by return only a
            specific number of records in each response, and through passing the
            page number you can navigate the different pages.
          $ref: '#/components/schemas/Pagination'
      x-apidog-orders:
        - status
        - success
        - data
        - pagination
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Pagination:
      type: object
      description: Pagination details for the response.
      properties:
        count:
          type: integer
          description: Number of items returned on the current page.
          examples:
            - 2
        total:
          type: integer
          description: Total number of items available across all pages.
          examples:
            - 1216
        perPage:
          type: integer
          description: Maximum number of items returned per page.
          examples:
            - 2
        currentPage:
          type: integer
          description: Current page number.
          examples:
            - 1
        totalPages:
          type: integer
          description: Total number of available pages.
          examples:
            - 608
        links:
          type: object
          description: Pagination navigation links.
          properties:
            next:
              type: string
              format: uri
              description: URL for retrieving the next page of results.
              examples:
                - >-
                  http://api.salla.dev/admin/v2/orders?per_page=2&connected_app_id=223306543&page=2
          x-apidog-orders:
            - next
          x-apidog-ignore-properties: []
      x-apidog-orders:
        - count
        - total
        - perPage
        - currentPage
        - totalPages
        - links
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    ListOrders:
      type: object
      properties:
        id:
          type: integer
          description: Unique order ID.
        external_reference_id:
          type: string
          description: External reference ID associated with the order, if available.
          nullable: true
        reference_id:
          type: integer
          description: Order reference ID.
        urls:
          type: object
          description: URLs associated with the order.
          properties:
            customer:
              type: string
              description: Customer-facing order URL.
            admin:
              type: string
              description: Merchant-facing order management URL.
          x-apidog-orders:
            - customer
            - admin
          x-apidog-ignore-properties: []
        total:
          type: object
          description: Final total amount of the order.
          properties:
            amount:
              type: number
              description: Final order total amount.
            currency:
              type: string
              description: Currency code of the total amount.
          x-apidog-orders:
            - amount
            - currency
          x-apidog-ignore-properties: []
        exchange_rate:
          type: object
          description: Currency exchange rate information associated with the order.
          properties:
            base_currency:
              type: string
              description: Base currency used for the exchange rate.
            exchange_currency:
              type: string
              description: Currency into which the base currency is exchanged.
            rate:
              type: string
              description: Exchange rate between the base and exchange currencies.
          x-apidog-orders:
            - base_currency
            - exchange_currency
            - rate
          x-apidog-ignore-properties: []
        scope_exchange_rate:
          type: object
          description: Scope-specific exchange rate information, if available.
          x-apidog-orders: []
          properties: {}
          x-apidog-ignore-properties: []
          nullable: true
        date:
          type: object
          description: Order creation date and time information.
          properties:
            date:
              type: string
              description: Order creation date and time.
            timezone_type:
              type: integer
              description: Timezone type associated with the date.
            timezone:
              type: string
              description: Timezone associated with the date.
          x-apidog-orders:
            - date
            - timezone_type
            - timezone
          x-apidog-ignore-properties: []
        source:
          type: string
          description: Source associated with the order.
        status:
          type: object
          description: Current order status.
          properties:
            id:
              type: integer
              description: Order status ID.
            name:
              type: string
              description: Order status name.
            slug:
              type: string
              description: Machine-readable order status slug.
            customized:
              type: object
              description: Customized order status information, if available.
              properties:
                id:
                  type: integer
                  description: Customized status ID.
                name:
                  type: string
                  description: Customized status name.
              x-apidog-orders:
                - id
                - name
              x-apidog-ignore-properties: []
              nullable: true
          x-apidog-orders:
            - id
            - name
            - slug
            - customized
          x-apidog-ignore-properties: []
        draft:
          type: boolean
          description: Indicates whether the order is a draft.
        read:
          type: boolean
          description: Indicates whether the order has been read.
        can_cancel:
          type: boolean
          description: Indicates whether the order can be cancelled.
        can_reorder:
          type: boolean
          description: Indicates whether the order can be reordered.
        payment_method:
          type: string
          description: Primary payment method used for the order.
        payment_methods:
          type: array
          description: List of payment methods associated with the order.
          items:
            type: object
            properties:
              amount:
                type: number
                description: Amount associated with the payment method.
              payment_method:
                type: string
                description: Payment method identifier.
              transaction_reference:
                type: string
                description: Payment transaction reference, if available.
            x-apidog-orders:
              - amount
              - payment_method
              - transaction_reference
            x-apidog-ignore-properties: []
        is_pending_payment:
          type: boolean
          description: Indicates whether the order is awaiting payment.
        pending_payment_ends_at:
          type: integer
          description: Pending payment expiration value.
        is_overweighted:
          type: boolean
          description: Indicates whether the order exceeds the allowed weight.
        features:
          type: object
          description: Features and capabilities available for the order.
          properties:
            shippable:
              type: boolean
              description: Indicates whether the order can be shipped.
            is_international:
              type: boolean
              description: Indicates whether the order is international.
            internationally_shippable:
              type: boolean
              description: Indicates whether the order can be shipped internationally.
            digitalable:
              type: boolean
              description: >-
                Indicates whether the order supports digital products or
                content.
            pickable:
              type: boolean
              description: Indicates whether the order supports pickup.
            has_suspicious_alert:
              type: boolean
              description: Indicates whether the order has a suspicious activity alert.
            bullet_delivery:
              type: object
              description: Bullet and on-demand delivery details.
              properties:
                is_bullet_delivery:
                  type: boolean
                  description: Indicates whether Bullet Delivery is enabled.
                bullet_countdown:
                  type: integer
                  description: Countdown value associated with Bullet Delivery.
                on_demand_countdown:
                  type: integer
                  description: Countdown value associated with on-demand delivery.
                on_demand_delivery:
                  type: boolean
                  description: Indicates whether on-demand delivery is enabled.
                on_demand_timer:
                  type: boolean
                  description: Indicates whether the on-demand delivery timer is enabled.
              x-apidog-orders:
                - is_bullet_delivery
                - bullet_countdown
                - on_demand_countdown
                - on_demand_delivery
                - on_demand_timer
              x-apidog-ignore-properties: []
          x-apidog-orders:
            - shippable
            - is_international
            - internationally_shippable
            - digitalable
            - pickable
            - has_suspicious_alert
            - bullet_delivery
          x-apidog-ignore-properties: []
        gateway:
          type: object
          description: Payment gateway information, if available.
          x-apidog-orders: []
          properties: {}
          x-apidog-ignore-properties: []
          nullable: true
        payment_actions:
          type: object
          description: Payment-related actions and payment state associated with the order.
          properties:
            refund_action:
              type: object
              description: Refund information and actions available for the order.
              properties:
                refunded_transactions:
                  type: array
                  description: List of transactions that have already been refunded.
                  items:
                    type: object
                    x-apidog-orders: []
                    properties: {}
                    x-apidog-ignore-properties: []
                pending_refund_amount:
                  type: number
                  description: Amount currently pending for refund, if applicable.
                  x-apidog-orders: []
                  properties: {}
                  x-apidog-ignore-properties: []
                  nullable: true
                has_refund_amount:
                  type: boolean
                  description: Indicates whether an amount is available for refund.
                payment_method_label:
                  type: string
                  description: Display label of the payment method.
                can_print_refund_invoice:
                  type: boolean
                  description: Indicates whether a refund invoice can be printed.
                paid_amount:
                  type: object
                  description: Amount already paid for the order.
                  properties:
                    amount:
                      type: number
                      description: Paid amount.
                    currency:
                      type: string
                      description: Currency code of the paid amount.
                  x-apidog-orders:
                    - amount
                    - currency
                  x-apidog-ignore-properties: []
                refund_amount:
                  type: object
                  description: Refund amount information.
                  properties:
                    amount:
                      type: number
                      description: Refund amount.
                    currency:
                      type: string
                      description: Currency code of the refund amount.
                  x-apidog-orders:
                    - amount
                    - currency
                  x-apidog-ignore-properties: []
                loyalty_point_programs:
                  type: array
                  description: Loyalty point programs associated with the refund.
                  items:
                    type: object
                    x-apidog-orders: []
                    properties: {}
                    x-apidog-ignore-properties: []
                can_send_sms:
                  type: boolean
                  description: Indicates whether an SMS notification can be sent.
                can_send_sms_msg:
                  type: string
                  description: >-
                    Message describing SMS notification availability or
                    requirements.
                can_refund_loyalty_prize_points:
                  type: boolean
                  description: Indicates whether loyalty prize points can be refunded.
                can_restore_loyalty_buy_from_store_points:
                  type: boolean
                  description: >-
                    Indicates whether loyalty points earned from the store
                    purchase can be restored.
                can_refund_to_wallet:
                  type: boolean
                  description: >-
                    Indicates whether the refund can be issued to the customer's
                    wallet.
              x-apidog-orders:
                - refunded_transactions
                - pending_refund_amount
                - has_refund_amount
                - payment_method_label
                - can_print_refund_invoice
                - paid_amount
                - refund_amount
                - loyalty_point_programs
                - can_send_sms
                - can_send_sms_msg
                - can_refund_loyalty_prize_points
                - can_restore_loyalty_buy_from_store_points
                - can_refund_to_wallet
              x-apidog-ignore-properties: []
            remaining_action:
              type: object
              description: >-
                Information and actions related to any remaining unpaid order
                amount.
              properties:
                has_remaining_amount:
                  type: boolean
                  description: >-
                    Indicates whether the order has a remaining amount to be
                    paid.
                payment_method_label:
                  type: string
                  description: Display label of the payment method.
                paid_amount:
                  type: object
                  description: Amount already paid toward the order.
                  properties:
                    amount:
                      type: number
                      description: Paid amount.
                    currency:
                      type: string
                      description: Currency code of the paid amount.
                  x-apidog-orders:
                    - amount
                    - currency
                  x-apidog-ignore-properties: []
                checkout_url:
                  type: string
                  description: Checkout URL used to pay the remaining amount.
                remaining_amount:
                  type: number
                  description: Remaining order amount to be paid, if applicable.
                  x-apidog-orders: []
                  properties: {}
                  x-apidog-ignore-properties: []
                  nullable: true
              x-apidog-orders:
                - has_remaining_amount
                - payment_method_label
                - paid_amount
                - checkout_url
                - remaining_amount
              x-apidog-ignore-properties: []
          x-apidog-orders:
            - refund_action
            - remaining_action
          x-apidog-ignore-properties: []
        items:
          type: array
          description: Summary of items included in the order.
          items:
            type: object
            properties:
              name:
                type: string
                description: Product name.
              quantity:
                type: integer
                description: Quantity of the product included in the order.
              thumbnail:
                type: string
                description: Product thumbnail image URL, if available.
                nullable: true
            x-apidog-orders:
              - name
              - quantity
              - thumbnail
            x-apidog-ignore-properties: []
        customer:
          type: object
          description: Customer information associated with the order.
          properties:
            id:
              type: integer
              description: Unique customer ID.
            full_name:
              type: string
              description: Customer's full name.
            first_name:
              type: string
              description: Customer's first name.
            last_name:
              type: string
              description: Customer's last name.
            mobile:
              type: integer
              description: Customer's mobile number.
            mobile_code:
              type: string
              description: >-
                International calling code associated with the customer's mobile
                number.
            email:
              type: string
              description: Customer's email address.
            urls:
              type: object
              description: URLs associated with the customer.
              properties:
                customer:
                  type: string
                  description: Customer-facing profile URL.
                admin:
                  type: string
                  description: Merchant-facing customer management URL.
              x-apidog-orders:
                - customer
                - admin
              x-apidog-ignore-properties: []
            avatar:
              type: string
              description: URL of the customer's avatar, if available.
              nullable: true
            gender:
              type: string
              description: Customer's gender, if available.
              nullable: true
            birthday:
              type: object
              description: Customer's date of birth information, if available.
              properties:
                date:
                  type: string
                  description: Customer's date of birth.
                timezone_type:
                  type: integer
                  description: Timezone type associated with the date.
                timezone:
                  type: string
                  description: Timezone associated with the date.
              x-apidog-orders:
                - date
                - timezone_type
                - timezone
              x-apidog-ignore-properties: []
              nullable: true
            city:
              type: string
              description: Customer's city, if available.
              nullable: true
            country:
              type: string
              description: Customer's country, if available.
              nullable: true
            country_code:
              type: string
              description: Customer's country code, if available.
              nullable: true
            currency:
              type: string
              description: Customer's associated currency.
            location:
              type: string
              description: Customer's location information, if available.
              nullable: true
            lang:
              type: string
              description: Customer's preferred language.
            created_at:
              type: object
              description: Customer creation date and time information.
              properties:
                date:
                  type: string
                  description: Date and time when the customer record was created.
                timezone_type:
                  type: integer
                  description: Timezone type associated with the date.
                timezone:
                  type: string
                  description: Timezone associated with the date.
              x-apidog-orders:
                - date
                - timezone_type
                - timezone
              x-apidog-ignore-properties: []
            updated_at:
              type: object
              description: Customer last update date and time information.
              properties:
                date:
                  type: string
                  description: Date and time when the customer record was last updated.
                timezone_type:
                  type: integer
                  description: Timezone type associated with the date.
                timezone:
                  type: string
                  description: Timezone associated with the date.
              x-apidog-orders:
                - date
                - timezone_type
                - timezone
              x-apidog-ignore-properties: []
            type:
              type: string
              description: Customer account type.
            groups:
              type: array
              description: List of groups associated with the customer.
              items:
                type: object
                x-apidog-orders: []
                properties: {}
                x-apidog-ignore-properties: []
          x-apidog-orders:
            - id
            - full_name
            - first_name
            - last_name
            - mobile
            - mobile_code
            - email
            - urls
            - avatar
            - gender
            - birthday
            - city
            - country
            - country_code
            - currency
            - location
            - lang
            - created_at
            - updated_at
            - type
            - groups
          x-apidog-ignore-properties: []
      x-apidog-orders:
        - id
        - external_reference_id
        - reference_id
        - urls
        - total
        - exchange_rate
        - scope_exchange_rate
        - date
        - source
        - status
        - draft
        - read
        - can_cancel
        - can_reorder
        - payment_method
        - payment_methods
        - is_pending_payment
        - pending_payment_ends_at
        - is_overweighted
        - features
        - gateway
        - payment_actions
        - items
        - customer
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    error_unauthorized_401:
      type: object
      properties:
        status:
          type: number
          description: >-
            Response status code, a numeric or alphanumeric identifier used to
            convey the outcome or status of a request, operation, or transaction
            in various systems and applications, typically indicating whether
            the action was successful, encountered an error, or resulted in a
            specific condition.
        success:
          type: boolean
          description: >-
            Response flag, boolean indicator used to signal a particular
            condition or state in the response of a system or application, often
            representing the presence or absence of certain conditions or
            outcomes.
        error:
          $ref: '#/components/schemas/Unauthorized'
      x-apidog-orders:
        - status
        - success
        - error
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Unauthorized:
      type: object
      x-examples: {}
      title: Unauthorized
      properties:
        code:
          type: string
          description: Code Error
        message:
          type: string
          description: Message Error
      x-apidog-orders:
        - code
        - message
      required:
        - code
        - message
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes:
    bearerAuth:
      type: bearer
      scheme: bearer
    bearerAuth1:
      type: jwt
      scheme: bearer
      bearerFormat: JWT
    api_key:
      type: apikey
      name: api_key
      in: header
    petstore_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://petstore.swagger.io/oauth/authorize
          scopes:
            read:pets: read your pets
            write:pets: modify pets in your account
    bearer:
      type: http
      scheme: bearer
    oauth21:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.salla.sa/oauth2/auth
          tokenUrl: ' https://accounts.salla.sa/oauth2/token '
          refreshUrl: ''
          scopes:
            offline_access: ''
          x-apidog:
            addTokenTo: header
            useTokenType: access_token
            queryParamKey: access_token
            headerPrefix: Bearer
            state: '12345678'
            redirectUri: https://app.apidog.com/oauth2-browser-callback.html
            clientId: 8a6c31ed-b841-48ca-85a9-3596e4d60d01
            clientSecret: 1c9c66a597ec06c7ab9cd89d9d4e9a8bed005e6ee279e35ede14f905170b1ea5
            codeVerifier: ''
            challengeAlgorithm: S256
            clientAuthentication: body
            useTokenConfigAsRefreshTokenConfig: true
            authRequestParams: []
            tokenRequestParams: []
servers:
  - url: ''
    description: Cloud Mock
  - url: https://api.salla.dev/admin/v2
    description: Production
security:
  - oauth21:
      - offline_access

```
