Sign in

v6

latestOpenAPI 3.1.02026-08-052432373.8 MB

Cancel a Physical Check Batch

Cancel a pending Physical Check Batch, which cancels all of its related checks.

post/physical_check_batches/{physical_check_batch_id}/cancel

Path parameters

physical_check_batch_idstring required

The identifier of the pending Physical Check Batch to cancel.

Response

Physical Check Batch

created_atstring date-time required

The ISO 8601 date and time at which the Physical Check Batch was created.

idstring required

The Physical Check Batch's identifier.

idempotency_keystring nullable required

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

shipping_method'usps_first_class' | 'fedex_overnight' required

The shipping method for the parcel.

status'pending' | 'completed' | 'canceled' | 'requires_attention' required

The lifecycle status of the Physical Check Batch.

type'physical_check_batch' required

A constant representing the object's type. For this resource it will always be physical_check_batch.

Example response

{
  "created_at": "2020-01-31T23:59:59Z",
  "id": "physical_check_batch_yzdwjhdbw0in6191whce",
  "idempotency_key": null,
  "mailing_address": {
    "city": "New York",
    "line1": "33 Liberty Street",
    "line2": null,
    "name": "Ian Crease",
    "phone": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "return_address": {
    "city": "New York",
    "line1": "33 Liberty Street",
    "line2": null,
    "name": "National Phonograph Company",
    "phone": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "shipping_method": "usps_first_class",
  "status": "pending",
  "type": "physical_check_batch"
}