Products

Actions available on products.

List

Retrieve a list of matching products.

Request

  • url: /admin/api/v2/products
  • method: GET

  • filters: (how?)

    • code: optional, string, exact match
    • name: optional, string, partial match

Response

products.json
{
  "data": [
    {
      "id": "7GZEJPE2",
      "code": "GENERAL",
      "name": "Make  a Difference",
      "description": "Give Where It's Needed Most",
      "feature_image": {
        "id": "GKJDZJD2",
        "full": "https://cdn.givecloud.co/s/files/1/0000/1281/files/jason-leung-xaanw0s0pmk-unsplash.jpg",
        "thumb": "https://cdn.givecloud.co/s/files/2/0000/1281/files/jason-leung-xaanw0s0pmk-unsplash_300x_cropped_top.jpg",
        "is_audio": false,
        "is_image": true,
        "is_video": false,
        "created_at": "2020-11-21T00:05:19Z",
        "updated_at": "2020-11-21T00:05:19Z"
      },
      "url": "https://{url}/give",
      "price": {
        "amount": 0,
        "currency_code": "USD"
      },
      "price_min": {
        "amount": 0,
        "currency_code": "USD"
      },
      "price_max": {
        "amount": 0,
        "currency_code": "USD"
      },
      "donation_min": {
        "amount": 0,
        "currency_code": "USD"
      },
      "sale_price": {
        "amount": 0,
        "currency_code": "USD"
      },
      "actual_price": {
        "amount": 0,
        "currency_code": "USD"
      },
      "qty_available": 99999999,
      "recurring_frequency": [
        null
      ],
      "recurring_schedule": "natural",
      "recurring_with_dpo": false,
      "goal_amount": {
        "amount": 50000,
        "currency_code": "USD"
      },
      "goal_progress": {
        "amount": 18817,
        "currency_code": "USD"
      },
      "goal_deadline": "2021-03-31T00:00:00.000000Z",
      "is_new": false,
      "is_sale": false,
      "is_featured": false,
      "is_clearance": false,
      "is_tax_receiptable": false,
      "cover_costs_enabled": true,
      "is_tribute": false,
      "enable_check_in": false,
      "enable_out_of_stock": true,
      "enable_social_buttons": false,
      "enable_tributes": false,
      "tribute_notification_types": [],
      "require_tributes": false,
      "ach_only": false,
      "hide_price": false,
      "hide_qty": false,
      "page_title": null,
      "page_description": null,
      "page_keywords": null,
      "page_content": null,
      "out_of_stock_message": null,
      "primary_button_label": null,
      "alternate_button_label": null,
      "alternate_button_url": null,
      "created_at": "2019-06-28T14:40:55Z",
      "updated_at": "2021-07-29T03:08:07Z",
      "published_at": "",
      "unpublish_at": "",
      "meta": [
        "001-TITHES",
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null
      ],
      "default_donation_amount": null,
      "default_donation_options": null,
      "default_recurring_donation_options": null,
      "variants": [
        {
          "id": "P59EKZDK",
          "code": "GENERAL",
          "title": "Monthly",
          "images": [],
          "price": {
            "amount": 0,
            "currency_code": "USD"
          },
          "price_presets": "250,100,50,25,15,other",
          "sale_price": {
            "amount": 0,
            "currency_code": "USD"
          },
          "minimum_price": 5,
          "on_sale": false,
          "is_default": true,
          "is_shippable": false,
          "is_donation": true,
          "billing_period": "monthly",
          "inventory_management": "givecloud",
          "inventory_policy": "continue",
          "inventory_quantity": -2,
          "inventory_updated_at": "2021-06-24T03:10:24Z",
          "shipping_expectation": null,
          "fair_market_value": {
            "amount": 0,
            "currency_code": "USD"
          },
          "sequence": 1,
          "weight": null,
          "created_at": "",
          "updated_at": ""
        },
        {
          "id": "7GZEJPE2",
          "code": "GENERAL",
          "title": "Today Only",
          "images": [],
          "price": {
            "amount": 0,
            "currency_code": "USD"
          },
          "price_presets": "250,100,50,25,15,other",
          "sale_price": {
            "amount": 0,
            "currency_code": "USD"
          },
          "minimum_price": 5,
          "on_sale": false,
          "is_default": false,
          "is_shippable": false,
          "is_donation": true,
          "billing_period": "onetime",
          "inventory_management": "givecloud",
          "inventory_policy": "continue",
          "inventory_quantity": -2,
          "inventory_updated_at": "2020-11-25T13:19:32Z",
          "shipping_expectation": null,
          "fair_market_value": {
            "amount": 0,
            "currency_code": "USD"
          },
          "sequence": 2,
          "weight": null,
          "created_at": "",
          "updated_at": ""
        }
      ]
    }
  ]
}

Get

Retrieve the first matching product. This returns a 404 if there is no matching product found.

Request

  • url: /admin/api/v2/products/{id}
  • method: GET

  • parameters:

    • id: required, string, exact match

Response

product.json
{
  "data": {
    "id": "7GZEJPE2",
    "code": "GENERAL",
    "name": "Make  a Difference",
    "description": "Give Where It's Needed Most",
    "feature_image": {
      "id": "GKJDZJD2",
      "full": "https://cdn.givecloud.co/s/files/1/0000/1281/files/jason-leung-xaanw0s0pmk-unsplash.jpg",
      "thumb": "https://cdn.givecloud.co/s/files/2/0000/1281/files/jason-leung-xaanw0s0pmk-unsplash_300x_cropped_top.jpg",
      "is_audio": false,
      "is_image": true,
      "is_video": false,
      "created_at": "2020-11-21T00:05:19Z",
      "updated_at": "2020-11-21T00:05:19Z"
    },
    "url": "https://{url}/give",
    "price": {
      "amount": 0,
      "currency_code": "USD"
    },
    "price_min": {
      "amount": 0,
      "currency_code": "USD"
    },
    "price_max": {
      "amount": 0,
      "currency_code": "USD"
    },
    "donation_min": {
      "amount": 0,
      "currency_code": "USD"
    },
    "sale_price": {
      "amount": 0,
      "currency_code": "USD"
    },
    "actual_price": {
      "amount": 0,
      "currency_code": "USD"
    },
    "qty_available": 99999999,
    "recurring_frequency": [
      null
    ],
    "recurring_schedule": "natural",
    "recurring_with_dpo": false,
    "goal_amount": {
      "amount": 50000,
      "currency_code": "USD"
    },
    "goal_progress": {
      "amount": 18817,
      "currency_code": "USD"
    },
    "goal_deadline": "2021-03-31T00:00:00.000000Z",
    "is_new": false,
    "is_sale": false,
    "is_featured": false,
    "is_clearance": false,
    "is_tax_receiptable": false,
    "cover_costs_enabled": true,
    "is_tribute": false,
    "enable_check_in": false,
    "enable_out_of_stock": true,
    "enable_social_buttons": false,
    "enable_tributes": false,
    "tribute_notification_types": [],
    "require_tributes": false,
    "ach_only": false,
    "hide_price": false,
    "hide_qty": false,
    "page_title": null,
    "page_description": null,
    "page_keywords": null,
    "page_content": null,
    "out_of_stock_message": null,
    "primary_button_label": null,
    "alternate_button_label": null,
    "alternate_button_url": null,
    "created_at": "2019-06-28T14:40:55Z",
    "updated_at": "2021-07-29T03:08:07Z",
    "published_at": "",
    "unpublish_at": "",
    "meta": [
      "001-TITHES",
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null
    ],
    "default_donation_amount": null,
    "default_donation_options": null,
    "default_recurring_donation_options": null,
    "variants": [
      {
        "id": "P59EKZDK",
        "code": "GENERAL",
        "title": "Monthly",
        "images": [],
        "price": {
          "amount": 0,
          "currency_code": "USD"
        },
        "price_presets": "250,100,50,25,15,other",
        "sale_price": {
          "amount": 0,
          "currency_code": "USD"
        },
        "minimum_price": 5,
        "on_sale": false,
        "is_default": true,
        "is_shippable": false,
        "is_donation": true,
        "billing_period": "monthly",
        "inventory_management": "givecloud",
        "inventory_policy": "continue",
        "inventory_quantity": -2,
        "inventory_updated_at": "2021-06-24T03:10:24Z",
        "shipping_expectation": null,
        "fair_market_value": {
          "amount": 0,
          "currency_code": "USD"
        },
        "sequence": 1,
        "weight": null,
        "created_at": "",
        "updated_at": ""
      },
      {
        "id": "7GZEJPE2",
        "code": "GENERAL",
        "title": "Today Only",
        "images": [],
        "price": {
          "amount": 0,
          "currency_code": "USD"
        },
        "price_presets": "250,100,50,25,15,other",
        "sale_price": {
          "amount": 0,
          "currency_code": "USD"
        },
        "minimum_price": 5,
        "on_sale": false,
        "is_default": false,
        "is_shippable": false,
        "is_donation": true,
        "billing_period": "onetime",
        "inventory_management": "givecloud",
        "inventory_policy": "continue",
        "inventory_quantity": -2,
        "inventory_updated_at": "2020-11-25T13:19:32Z",
        "shipping_expectation": null,
        "fair_market_value": {
          "amount": 0,
          "currency_code": "USD"
        },
        "sequence": 2,
        "weight": null,
        "created_at": "",
        "updated_at": ""
      }
    ]
  }
}