Ordergroove Developer Documentation

{
  "next": "https://restapi.ordergroove.com/placement_logs/responses/?cursor=cD0yMDI0LTA4LTA0KzE2JTNBNTglM0ExMi4yNDUwMDA%3D",
  "previous": "https://restapi.ordergroove.com/placement_logs/responses/?cursor=cD0yMDI0LTA4LTA0KzE2JTNBNTglM0ExMi4yNDUwMDA%3D",
  "results": [
    {
      "public_id": "3f2a9c1e7b4d4e8a9c0d1e2f3a4b5c6d",
      "merchant": "asdf123",
      "order": "6fda37265d2811ef92240241a91b1780",
      "customer": "12345",
      "response_code": "140",
      "response_message": "Selected Credit Card was declined. Please enter new Credit Card and try again.",
      "response_order_id": null,
      "created": "2024-11-24 08:59:15",
      "response_payload": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><order><code>ERROR</code><errorCode>140</errorCode><errorMsg>Selected Credit Card was declined. Please enter new Credit Card and try again.</errorMsg></order>",
      "transaction_response": null
    }
  ]
}

Returns placement responses, oldest first, using cursor-based pagination. Requires Application API Scope. For how to page through the results, see Cursor Pagination, and for what each field holds, see Order Billing Attempts.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

Query parameters

start_datedatetimeOptional

Filter by entries created on or after a specific date/time. Expected format is YYYY-MM-DD HH:mm:ss

end_datedatetimeOptional

Filter by entries created before (non-inclusive) a specific date/time. Expected format is YYYY-MM-DD HH:mm:ss

page_sizedoubleOptional

Number of results to be retrieved in each page. Default value is 10. Maximum allowed is 1000.

Response

Successful retrieval of placement responses

nextstring or nullOptional

URL for the next page of results, or null if at the last page

previousstring or nullOptional

URL for the previous page of results, or null if at the first page

resultslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error