REreacherapp
Contracts

Get send progress for a contract batch

Changed on

Progress for one batch of contracts: total_count / sent_count / failed_count, every envelope in the batch, and a failures list naming the creators whose delivery failed and why. Poll this after a batch is sent from the portal to watch it drain.

404 when the batch does not belong to this shop. Single-shop only.

get/contracts/batches/{batch_id}

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/contracts/batches/{batch_id}
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Path parameters

batch_idstring uuid required

Batch id (UUID).

Response

Successful Response

batch_idstring uuid required
status'queued' | 'sending' | 'completed' | 'partial_failure' | 'failed' required
total_countinteger required
sent_countinteger required
failed_countinteger required

Changes

  • 2a7ed9f8c407Revision changes
    • warning

      added the new gmv_and_live_gmv enum value to the ///// response property for the response status

    • warning

      added the new videos_gmv_and_live_gmv enum value to the ///// response property for the response status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 34cc040be296Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status