Query parameters

• verbose boolean

  Get Verbose Response

• page integer(int32)

  Page Number

• limit integer(int32)

  Number of items per page

Responses

• 200 application/json

  A list of orders is returned, based on the verbose query parameter.

  • When verbose=true, the response object OrderVerbose includes detailed information about each order, including line items, and other associations like Customer and Vendor details, Invoice Details if generated.

  • When verbose=false, the response object OrderSummary includes basic information about each order, like Order Number, Status, Sub Total, Total, Vendor Name, Buyer Company Name, and Invoice Status.

  Hide response attributes Show response attributes object

  • pagination object
    Hide pagination attributes Show pagination attributes object

    • current integer(int32)
    • previous integer(int32)
    • next integer(int32)
    • limit integer(int32)
    • total_pages integer(int32)
    • total_count integer(int32)
  • data array[object]
    One of:

    OrderSummary object OrderVerbose object

    Hide attributes Show attributes

    • id string(guid)

      System generated unique identifier. Don't include this in POST request body.

    • order_number string
    • status string

      Values are received, confirmed, shipped, completed, or cancelled.

    • sub_total string(float)
    • total string(float)
    • vendor_id string(guid)
    • vendor_name string
    • vendor_minimum_order_value string(float)
    • buyer_id string(guid)

      Customer ID

    • buyer_user_id string(guid)

      User ID of the customer

    • buyer_company_name string

      Company/Business Name of the customer

    • invoice_status string

      Invoice Status

    • created_at string(date-time)
    • updated_at string(date-time)

    Hide attributes Show attributes

    • id string(guid)

      System generated unique identifier. Don't include this in POST request body.

    • order_number string
    • status string

      Values are received, confirmed, shipped, completed, or cancelled.

    • sub_total string(float)
    • total string(float)
    • shipping_name string

      Name on the Shipping Address

    • shipping_email string(email)

      Email on the Shipping Address

    • shipping_company string

      Name of the company associated to the Shipping Address

    • shipping_phone string(phone)

      Phone number on the Shipping Address

    • shipping_address1 string

      Shipping Address Line 1

    • shipping_address2 string

      Shipping Address Line 2

    • shipping_city string

      Shipping Address City

    • shipping_state string

      Shipping Address State, Province, Territory or Subdivision

    • shipping_country string

      Shipping Address Country

    • shipping_zip string

      Shipping Address Zip or Postal Code

    • billing_name string

      Name on the Billing Address

    • billing_email string(email)

      Email on the Billing Address

    • billing_company string

      Name of the company associated to the Billing Address

    • billing_phone string(phone)

      Phone number on the Billing Address

    • billing_address1 string

      Billing Address Line 1

    • billing_address2 string

      Billing Address Line 2

    • billing_city string

      Billing Address City

    • billing_state string

      Billing Address State, Province, Territory or Subdivision

    • billing_country string

      Billing Address Country

    • billing_zip string

      Billing Address Zip or Postal Code

    • payment_status string
    • transaction_fee string
    • billing_payment_method_type string
    • billing_payment_method_instruction_pay_to string(nullable)
    • billing_payment_method_instruction_send_to_address string(nullable)
    • billing_payment_method_instruction_memo string(nullable)
    • billing_payment_method_instruction_other string(nullable)
    • order_line_items array[object]
      Hide order_line_items attributes Show order_line_items attributes object

      • item_id string(guid)
      • title string

        Product Title

      • variant string

        Product Variant

      • sku string

        Product SKU

      • quantity integer(int32)

        Quantity of the product in the order

      • unit_price string(float)

        Unit Price of the product

      • total_price string(float)

        Total Price of the product (quantity * unit_price)

      • discount_amount string(float)

        Discount Amount

      • categoy_name string

        Category Name to which the product belongs

      • vendor_name string

        Vendor Name

    • created_at string(date-time)
    • updated_at string(date-time)
    • po_number string

      Purchase Order Number

    • order_line_items_discount_amount string(float)

      Total Discount Amount on the Order Line Items

    • order_comments array[object]

      Order Comments
• 401 application/json

  Unauthorized

  Hide response attributes Show response attributes object

  • error string

    401: Invalid Credentials

    404: Resource not found

    422: Unprocessable Entity

  • details string

    404: empty

    401: The credentials presented are not valid to access this resource