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

# Get order

> Get order



## OpenAPI

````yaml get /v2/orders/{id}
openapi: 3.1.0
info:
  description: Open API's for WizCommerce API's
  title: WizCommerce Open API's
  termsOfService: https://wizcommerce.com/terms/
  contact:
    name: Tech Support
    url: https://help.wizcommerce.com/
    email: tech@wizcommerce.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: '1.0'
servers:
  - url: https://api.wizcommerce.com
    description: Production BaseURL
  - url: https://api-staging.sourcerer.tech
    description: Staging BaseURL
security: []
paths:
  /v2/orders/{id}:
    get:
      tags:
        - Orders
      summary: Get order
      description: Get order
      parameters:
        - x-order: '1'
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dtos.SuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/dtosv2.OrderResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    dtos.SuccessResponse:
      type: object
      properties:
        data:
          x-order: '1'
    dtosv2.OrderResponse:
      type: object
      properties:
        id:
          description: UUID
          type: string
          x-order: '1'
          example: 01f5d171-d3e3-4b2b-bd57-0727194b5bed
        reference_id:
          type: string
          x-order: '2'
          example: '1234567890'
        display_id:
          type: string
          x-order: '3'
          example: WC_1234567890
        customer_id:
          type: string
          x-order: '4'
          example: '1234567890'
        customer_reference_id:
          type: string
          x-order: '5'
          example: CUST_1234567890
        customer_name:
          type: string
          x-order: '6'
          example: John Doe
        type:
          type: string
          enum:
            - order
            - quote
          x-order: '7'
          example: order
        status:
          type: string
          x-order: '8'
          example: active
        amount:
          type: number
          x-order: '9'
          example: 100
        amount_paid:
          type: number
          x-order: '10'
          example: 100
        shipment_date:
          type: string
          x-order: '11'
          example: '2021-01-01T00:00:00Z'
        due_date:
          type: string
          x-order: '12'
          example: '2021-01-01T00:00:00Z'
        payment_status:
          type: string
          x-order: '13'
          example: PAID
        fulfillment_status:
          type: string
          x-order: '14'
          example: >-
            PARTIALLY_DELIVERED UNFULFILLED PARTIALLY_FULFILLED FULFILLED
            IN_PROGRESS DELIVERED
        payment_method_id:
          type: string
          x-order: '15'
          example: '1234567890'
        payment_method:
          type: string
          x-order: '16'
          example: payment_method
        payment_term:
          type: string
          x-order: '17'
          example: payment_term
        shipping_method:
          type: string
          x-order: '18'
          example: shipping_method
        freight_term:
          type: string
          x-order: '19'
          example: freight_term
        internal_note:
          type: string
          x-order: '20'
          example: internal_note
        customer_note:
          type: string
          x-order: '21'
          example: customer_note
        source:
          description: Channel that last created or updated the order.
          type: string
          x-order: '22'
          example: cart
        entity_source:
          description: >-
            Channel the order was created in, e.g. wizorder (WizOrder), wizshop
            (Website), openapi. Written by the creating service, so other values
            are possible. Set at creation and not changed by later updates.
          type: string
          x-order: '22.5'
          example: wizorder
        price_list_id:
          type: string
          x-order: '23'
          example: '1234567890'
        price_list:
          allOf:
            - $ref: '#/components/schemas/dtosv2.PriceListResponse'
          x-order: '24'
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/dtosv2.OrderLineItemsResponse'
          x-order: '25'
        billing_address:
          allOf:
            - $ref: '#/components/schemas/dtosv2.OrderAddressDetailResponse'
          x-order: '26'
        shipping_address:
          allOf:
            - $ref: '#/components/schemas/dtosv2.OrderAddressDetailResponse'
          x-order: '27'
        primary_contact:
          allOf:
            - $ref: '#/components/schemas/dtosv2.OrderContactDetailResponse'
          x-order: '28'
        charges:
          type: array
          items:
            $ref: '#/components/schemas/dtosv2.OrderChargesResponse'
          x-order: '29'
        container_info:
          allOf:
            - $ref: '#/components/schemas/dtosv2.ContainerInfoResponse'
          x-order: '30'
        customer_consent:
          allOf:
            - $ref: '#/components/schemas/dtosv2.CustomerConsentResponse'
          x-order: '31'
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/attribute.AttributeValueResponse'
          x-order: '32'
        po_number:
          type: string
          x-order: '33'
        created_by:
          allOf:
            - $ref: '#/components/schemas/dtosv2.UserInfoResponse'
          x-order: '34'
        updated_by:
          allOf:
            - $ref: '#/components/schemas/dtosv2.UserInfoResponse'
          x-order: '35'
        created_at:
          type: string
          x-order: '36'
          example: '2021-01-01T00:00:00Z'
        updated_at:
          type: string
          x-order: '37'
          example: '2021-01-01T00:00:00Z'
        cart_total:
          description: >-
            Sum of line item totals from the order cart; null when the order has
            no cart details
          type: number
          x-order: '38'
          example: 100
        card:
          $ref: '#/components/schemas/dtosv2.PaymentCardResponse'
    errors.HttpError:
      type: object
      properties:
        code:
          type: string
          x-order: '1'
        message:
          type: string
          x-order: '2'
        details:
          type: array
          items:
            $ref: '#/components/schemas/errors.HttpErrorDetails'
          x-order: '3'
    dtosv2.PriceListResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 01f5d171-d3e3-4b2b-bd57-0727194b5bed
        name:
          type: string
          x-order: '2'
          example: Default Price List
        reference_id:
          type: string
          x-order: '3'
          example: PL_1234567890
    dtosv2.OrderLineItemsResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 01f5d171-d3e3-4b2b-bd57-0727194b5bed
        product_id:
          type: string
          x-order: '2'
          example: '1234567890'
        reference_id:
          type: string
          x-order: '3'
          example: '1234567890'
        sku:
          type: string
          x-order: '4'
          example: '1234567890'
        parent_sku_id:
          description: >-
            SKU of the source product this variant was created from; omitted for
            non-variant items.
          type: string
          x-order: '5'
        quantity:
          type: integer
          x-order: '6'
          example: 10
        unit_price:
          description: >-
            UnitPrice is the per-unit price before any discounts or promotions
            are applied.
          type: number
          x-order: '7'
          example: 100
        final_unit_price:
          description: >-
            FinalUnitPrice is the per-unit price after discounts and promotions
            are applied.
          type: number
          x-order: '8'
          example: 95
        shipped_quantity:
          type: integer
          x-order: '9'
          example: 0
        invoiced_quantity:
          type: integer
          x-order: '10'
          example: 0
        cancelled_quantity:
          type: integer
          x-order: '11'
          example: 0
        picked_quantity:
          type: integer
          x-order: '12'
          example: 0
        discount:
          type: number
          x-order: '13'
          example: 0
        discount_type:
          type: string
          enum:
            - percentage
            - value
          x-order: '14'
          example: percentage
        note:
          type: string
          maxLength: 255
          x-order: '15'
          example: Extra packing material
        is_adhoc:
          type: boolean
          x-order: '16'
          example: false
        applied_promotion:
          allOf:
            - $ref: '#/components/schemas/dtosv2.AppliedPromotionResponse'
          x-order: '17'
        applied_modifiers:
          type: array
          items:
            $ref: '#/components/schemas/dtosv2.OrderLineItemModifierResponse'
          x-order: '18'
    dtosv2.OrderAddressDetailResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 12345678-90ab-cdef-1234-567890abcdef
        first_name:
          type: string
          x-order: '2'
          example: John
        last_name:
          type: string
          x-order: '3'
          example: Doe
        phone:
          type: string
          x-order: '4'
          example: '+14155552671'
        email:
          type: string
          x-order: '5'
          example: john.doe@example.com
        address_line_1:
          type: string
          x-order: '6'
          example: 123 Main St
        address_line_2:
          type: string
          x-order: '7'
          example: Apt 101
        city:
          type: string
          x-order: '8'
          example: Anytown
        state:
          type: string
          x-order: '9'
          example: CA
        state_info:
          allOf:
            - $ref: '#/components/schemas/dtosv2.StateInfoResponse'
          x-order: '10'
        country:
          type: string
          x-order: '11'
          example: US
        country_info:
          allOf:
            - $ref: '#/components/schemas/dtosv2.CountryInfoResponse'
          x-order: '12'
        zip_code:
          type: string
          x-order: '13'
          example: '12345'
        reference_id:
          type: string
          x-order: '14'
          example: '1234567890'
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/dtosv2.OrderAddressAttributeResponse'
          x-order: '15'
    dtosv2.OrderContactDetailResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 12345678-90ab-cdef-1234-567890abcdef
        first_name:
          type: string
          x-order: '2'
          example: John
        last_name:
          type: string
          x-order: '3'
          example: Doe
        email:
          type: string
          x-order: '4'
          example: john.doe@example.com
        phone:
          type: string
          x-order: '5'
          example: '+14155552671'
        designation:
          type: string
          x-order: '6'
          example: Sales Manager
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/dtosv2.OrderContactAttributeResponse'
          x-order: '7'
        reference_id:
          type: string
          x-order: '7'
          example: 12345678-90ab-cdef-1234-567890abcdef
    dtosv2.OrderChargesResponse:
      type: object
      properties:
        name:
          type: string
          x-order: '1'
          example: shipping
        type:
          type: string
          x-order: '2'
          example: shipping
        value_type:
          type: string
          enum:
            - percentage
            - value
          x-order: '3'
          example: percentage
        amount:
          type: number
          x-order: '4'
          example: 100
        applied_promotion:
          allOf:
            - $ref: '#/components/schemas/dtosv2.AppliedPromotionResponse'
          x-order: '5'
    dtosv2.ContainerInfoResponse:
      type: object
      required:
        - key
        - unit
        - volume
      properties:
        name:
          type: string
          maxLength: 255
          x-order: '1'
          example: Container Name
        key:
          type: string
          maxLength: 255
          x-order: '2'
          example: 40ft_hig
        unit:
          type: string
          enum:
            - CFT
            - CBM
          x-order: '3'
          example: CFT
        volume:
          type: number
          x-order: '4'
          example: 100
    dtosv2.CustomerConsentResponse:
      type: object
      properties:
        has_consent:
          type: boolean
          x-order: '1'
          example: true
        consent_file_id:
          type: string
          x-order: '2'
          example: '1234567890'
    attribute.AttributeValueResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 01f5d171-d3e3-4b2b-bd57-0727194b5bed
        name:
          type: string
          x-order: '2'
          example: Color
        value:
          type: string
          x-order: '3'
          example: Red
        created_by:
          type: string
          x-order: '4'
          example: 01f5d171-d3e3-4b2b-bd57-0727194b5bed
        updated_by:
          type: string
          x-order: '5'
          example: 01f5d171-d3e3-4b2b-bd57-0727194b5bed
        created_at:
          type: string
          x-order: '6'
          example: '2021-01-01T00:00:00Z'
        updated_at:
          type: string
          x-order: '7'
          example: '2021-01-01T00:00:00Z'
    dtosv2.UserInfoResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 01f5d171-d3e3-4b2b-bd57-0727194b5bed
        email:
          type: string
          x-order: '2'
          example: user@example.com
    dtosv2.PaymentCardResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 01f5d171-d3e3-4b2b-bd57-0727194b5bed
        token:
          type: string
          x-order: '2'
          example: PIuTv1UgBqESZ2KRDixPtDJt
        payment_method_type:
          type: string
          x-order: '3'
          example: card
        brand:
          type: string
          x-order: '4'
          example: visa
        card_type:
          type: string
          x-order: '5'
          example: debit
        last_four_digits:
          type: string
          x-order: '6'
          example: '1111'
        card_exp:
          type: string
          x-order: '7'
          example: 09/25
        external_customer_id:
          type: string
          x-order: '8'
          example: cus_1234567890
    errors.HttpErrorDetails:
      type: object
      properties:
        field:
          type: string
          x-order: '1'
        reason:
          type: string
          x-order: '2'
    dtosv2.AppliedPromotionResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
        name:
          type: string
          x-order: '2'
        reference_id:
          type: string
          x-order: '3'
        promo_code:
          type: string
          x-order: '4'
    dtosv2.OrderLineItemModifierResponse:
      type: object
      properties:
        id:
          type: string
          example: 35ca9dd0-7c73-40b1-b964-051350edb956
        name:
          type: string
          example: Rug Pad
        unique_id:
          type: string
          example: RP
        values:
          type: array
          items:
            $ref: '#/components/schemas/dtosv2.OrderLineItemModifierValueResponse'
    dtosv2.StateInfoResponse:
      type: object
      properties:
        code:
          description: ISO 3166-2 code (country + state), e.g. US-CA
          type: string
          x-order: '1'
          example: US-CA
        short_code:
          description: State/region code within the country, e.g. CA
          type: string
          x-order: '2'
          example: CA
        name:
          description: Display name of the state/region, e.g. California
          type: string
          x-order: '3'
          example: California
    dtosv2.CountryInfoResponse:
      type: object
      properties:
        code:
          description: ISO 3166-1 alpha-3 (3-letter) country code, e.g. USA
          type: string
          x-order: '1'
          example: USA
        short_code:
          description: ISO 3166-1 alpha-2 (2-letter) country code, e.g. US
          type: string
          x-order: '2'
          example: US
        name:
          description: Display name of the country, e.g. United States
          type: string
          x-order: '3'
          example: United States
    dtosv2.OrderAddressAttributeResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 12345678-90ab-cdef-1234-567890abcdef
        name:
          type: string
          x-order: '2'
          example: Apartment Number
        value:
          type: string
          x-order: '3'
          example: Apt 101
        created_at:
          type: string
          x-order: '4'
          example: '2021-01-01T00:00:00Z'
        updated_at:
          type: string
          x-order: '5'
          example: '2021-01-01T00:00:00Z'
    dtosv2.OrderContactAttributeResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 12345678-90ab-cdef-1234-567890abcdef
        name:
          type: string
          x-order: '2'
          example: Department
        value:
          type: string
          x-order: '3'
          example: Sales
        created_at:
          type: string
          x-order: '4'
          example: '2021-01-01T00:00:00Z'
        updated_at:
          type: string
          x-order: '5'
          example: '2021-01-01T00:00:00Z'
    dtosv2.OrderLineItemModifierValueResponse:
      type: object
      properties:
        id:
          type: string
          example: 56fd881a-7ea3-44a9-a790-99cfe9c66cc3
        price:
          type: number
          example: 0
        quantity:
          type: integer
          example: 1
        suffix:
          type: string
          example: RP03
        value:
          type: string
          example: RP03 6X9
  securitySchemes:
    ApiKeyAuth:
      description: API Key for authentication
      type: apiKey
      name: X-API-Key
      in: header

````