Orders – Search Orders

This API request allows to you search through the orders in our system and return the information about your orders that match your search criteria.

The API requests takes the following parameters:

  • recipeID - required - your recipeID. You can get the recipeID from your Gooten Admin.
  • partnerBillingKey - required - your partner billing key. You can get the key from your Gooten Admin.
  • genericValues - optional - any value which is related to your orders (partner name, address, phone, etc…)
  • lastName - optional - last name provided in the order
  • email - optional - email provided in the order
  • postalCode - optional - partner postal code
  • startDate - optional - the start date for the date range of when your orders were created. The format for this parameter is yyyy-mm-dd or 2021-05-31.
  • endDate - optional - the end date for the date range of when your orders were created. The format for this parameter is yyyy-mm-dd or 2021-07-31.
  • uniqueUserId - optional - user 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": {
            "Key1": "Value1",
            "Key2": "Value2"
          },
          "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": {
        "Key1": "Value1",
        "Key2": "Value2"
      }
    }
  ],
  "TotalPages": "integer",
  "Page": "integer",
  "HadError": "boolean"
}

Next Topic: Getting Orders by ID