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

Each API request to the Gooten API must have the RecipeID parameter included in the URL. This is typically used to authenticate to the Gooten API. Please be sure to replace the YourRecipeID in the example with your proper RecipeID from the Gooten Admin.

You must also replace the YourPartnerBillingKey in the example with your own Partner Billing Key from the Gooten Admin. This key is used for order related API calls. In this scenario, it is used to pull the payment information for the orders you are searching.

When you provide your partnerBillingKey, you must encode it in order for the request to work. You can use an Encoder tool to help encode your partnerBillingKey.

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