This method is used to void a previously created labels.
An object containing information about the labels to void.
This object model represents the response from a successful void labels request.
{- "void_requests": [
- {
- "void_request_id": "be1c8d79-5406-4995-a114-6ec0b9dced3c",
- "ship_from": {
- "tax_identifiers": [
- {
- "id": "string",
- "type": "tin",
- "registration_country": "string",
- "description": "string"
}
], - "name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone_number": "string",
- "company_name": "string",
- "address_residential_indicator": "unknown",
- "instructions": "string",
- "address_metadata": {
- "property1": "string",
- "property2": "string"
}, - "address_lines": [
- "string"
], - "city_locality": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string"
}, - "tracking_number": "string",
- "ship_to": {
- "tax_identifiers": [
- {
- "id": "string",
- "type": "tin",
- "registration_country": "string",
- "description": "string"
}
], - "geolocation": [
- {
- "type": "what3words",
- "value": "string"
}
], - "name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone_number": "string",
- "company_name": "string",
- "address_residential_indicator": "unknown",
- "instructions": "string",
- "address_metadata": {
- "property1": "string",
- "property2": "string"
}, - "address_lines": [
- "string"
], - "city_locality": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string"
}, - "alternative_identifiers": [
- {
- "type": "string",
- "value": "string"
}
], - "service_code": "string",
- "packages": [
- {
- "tracking_number": "string",
- "tracking_url": "string",
- "alternative_identifiers": [
- {
- "type": "string",
- "value": "string"
}
], - "dimension_details": {
- "dimensions_in_centimeters": {
- "length": 0,
- "width": 0,
- "height": 0
}, - "dimensions_in_inches": {
- "length": 0,
- "width": 0,
- "height": 0
}, - "source_dimensions": {
- "length": 0,
- "width": 0,
- "height": 0
}, - "source_dimension_unit": "inches"
}, - "weight_details": {
- "weight_in_ounces": 0,
- "weight_in_grams": 0,
- "source_weight": 0,
- "source_weight_unit": "grams"
}, - "package_code": "string",
- "label_messages": {
- "reference1": "string",
- "reference2": "string",
- "reference3": "string"
}, - "customs": {
- "contents": "merchandise",
- "non_delivery": "return_to_sender",
- "buyer_shipping_amount_paid": {
- "amount": "string",
- "currency": "string"
}, - "duties_paid": {
- "amount": "string",
- "currency": "string"
}, - "bill_duties_to": {
- "bill_to_party": "shipper",
- "account_number": "string",
- "name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone_number": "string",
- "company_name": "string",
- "address_residential_indicator": "unknown",
- "instructions": "string",
- "address_metadata": {
- "property1": "string",
- "property2": "string"
}, - "address_lines": [
- null
], - "city_locality": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string"
}, - "declaration": "string",
- "terms_of_trade_code": "exw",
- "importer_of_record": {
- "tax_identifiers": [
- null
], - "name": "string",
- "company_name": "string",
- "address_line1": "string",
- "address_line2": "string",
- "city_locality": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "phone": "string",
- "email": "string"
}, - "invoice_additional_details": {
- "freight_charge": {
- "amount": null,
- "currency": null
}, - "other_charge": {
- "amount": null,
- "currency": null
}, - "other_charge_description": "string",
- "insurance_charge": {
- "amount": null,
- "currency": null
}, - "discount": {
- "amount": null,
- "currency": null
}
}, - "contents_explanation": "string",
- "export_declaration_number": "string"
}, - "insured_value": {
- "amount": "string",
- "currency": "string"
}, - "products": [
- {
- "description": "string",
- "quantity": 0,
- "value": {
- "amount": null,
- "currency": null
}, - "country_of_origin": "string",
- "harmonized_tariff_code": "string",
- "sku": "string",
- "sku_description": "string",
- "item_weight": {
- "weight_in_ounces": null,
- "weight_in_grams": null,
- "source_weight": null,
- "source_weight_unit": null
}, - "product_url": "string",
- "vat_rate": 0,
- "mid_code": "string",
- "dangerous_goods": [
- null
], - "property1": null,
- "property2": null
}
]
}
], - "advanced_options": {
- "contains_alcohol": true,
- "no_postage": true,
- "nonmachineable": true,
- "saturday_delivery": true,
- "tip": {
- "amount": "string",
- "currency": "string"
}, - "additional_handling": true,
- "collect_on_delivery": {
- "payment_amount": {
- "amount": "string",
- "currency": "string"
}, - "payment_type": "any"
}, - "own_document_upload": true,
- "dangerous_goods": true,
- "dangerous_goods_contact": {
- "name": "string",
- "phone": "string"
}, - "limited_quantity": true,
- "event_notification": true,
- "windsor_framework_details": {
- "movement_indicator": "b2c",
- "not_at_risk": true
}, - "property1": null,
- "property2": null
}, - "pickup_location": {
- "carrier_code": "string",
- "location_id": "string",
- "name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone_number": "string",
- "company_name": "string",
- "address_residential_indicator": "unknown",
- "instructions": "string",
- "address_metadata": {
- "property1": "string",
- "property2": "string"
}, - "address_lines": [
- "string"
], - "city_locality": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string"
}
}
], - "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "authorization": {
- "access_token": "string",
- "connection_context": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": { },
- "property2": { }
}, - "connection_name": "string"
}
{- "void_responses": [
- {
- "void_request_id": "be1c8d79-5406-4995-a114-6ec0b9dced3c",
- "message": "string",
- "errors": [
- "string"
], - "billing_line_items": [
- {
- "billing_category": "uncategorized",
- "carrier_description": "string",
- "carrier_billing_code": "string",
- "memo": "string",
- "amount": {
- "amount": "string",
- "currency": "string"
}
}
]
}
], - "metadata": {
- "property1": { },
- "property2": { }
}
}