increase-test
POST/physical_check_batches/{physical_check_batch_id}/cancel

Cancel a physical check batch

Cancels a pending physical check batch and all checks associated with it. Use the batch identifier to select the batch; only a pending batch can be canceled.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
physical_check_batch_idstringrequired
The identifier of the pending physical check batch to cancel.

3 status codes
200Returns the physical check batch with its current status and address and shipping details.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Physical Check Batch was created.
idstringrequired
The Physical Check Batch's identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
mailing_addressobjectrequired
The mailing address of the parcel.
return_addressobjectrequired
The return address of the parcel.
shipping_methodstringrequired
The shipping method for the parcel.
Allowed:usps_first_classfedex_overnight
statusstringrequired
The lifecycle status of the Physical Check Batch.
Allowed:pendingcompletedcanceledrequires_attention
typestringrequired
A constant representing the object's type. For this resource it will always be `physical_check_batch`.
Allowed:physical_check_batch
4XXReturned when the request cannot be fulfilled.
5XXReturned when the service encounters an internal error.

Error handling

The physical_check_batch_id path parameter must identify a pending physical check batch.