API Documentation

Orders - Search Orders

Search through the orders and return information about orders that match search criteria..

It takes an arguments:

  • partnerBillingKey - required - partner billing key
  • genericValues - optional - any value which is related to order (partner name, address, phone, couponCode, etc…)
  • lastName - optional - partner last name
  • email - optional - partner email
  • postalCode - optional - partner postal code
  • startDate - optional - start date of the date range when order was created
  • endDate - optional - end date of the date range when order was created
  • uniqueUserId - optional - user Id
  • partnerId - optional - partner Id
  • pageSize - optional - how many items to return in reponse
  • page - optional - page number, how many items to skip

This request yields the following response:

{
  "Orders": [
    {
      "Id": "string",
      "NiceId": "string",
      "SourceId": "string",
      "Items": [
        {
          "Sku": "string",
          "ProductId": "integer",
          "Product": "string",
          "Quantity": "integer",
          "Status": "string",
          "TrackingNumber": "string",
          "TrackingUrl": "string",
          "ShipCarrierName": "string",
          "Price": {
            "Price": "decimal",
            "CurrencyCode": "string",
            "FormattedPrice": "string",
            "CurrencyFormat": "string",
            "CurrencyDigits": "integer"
          },
          "DiscountAmount": {
            "Price": "decimal",
            "CurrencyCode": "string",
            "FormattedPrice": "string",
            "CurrencyFormat": "string",
            "CurrencyDigits": "integer"
          },
          "SourceId": "string",
          "Meta": {
            "Key": "string",
            "Value": "string"
          },
          "Shipments": [
            {
              "TrackingNumber": "string",
              "TrackingUrl": "string",
              "ShipCarrierName": "string"
            }
          ]
        }
      ],
      "Total": {
        "Price": "decimal",
        "CurrencyCode": "string",
        "FormattedPrice": "string",
        "CurrencyFormat": "string",
        "CurrencyDigits": "integer"
      },
      "ShippingTotal": {
        "Price": "decimal",
        "CurrencyCode": "string",
        "FormattedPrice": "string",
        "CurrencyFormat": "string",
        "CurrencyDigits": "integer"
      },
      "ShippingAddress": "Address",
      "BillingAddress": "Address",
      "DiscountCode": "string",
      "DiscountAmount": {
        "Price": "decimal",
        "CurrencyCode": "string",
        "FormattedPrice": "string",
        "CurrencyFormat": "string",
        "CurrencyDigits": "integer"
      },
      "Meta": {
        "Key": "string",
        "Value": "string"
      }
    }
  ],
  "TotalPages": "integer",
  "Page": "integer",
  "HadError": "boolean"
}

Next Topic: Getting Orders by ID