Long Description
Get the suggested shipping method for a ticket group based on the address provided. This endpoint takes into account the shipping methods established for the API credential used as well as the in_hand
status of the ticket group, the in_hand_on
date, the date and time of the event as well as the date and time the request is made.
You must provide either an address_id
or the full address_attributes
.
Parameters
Name | Description | Value Type | Required |
---|---|---|---|
ticket_group_id | ID of the ticket group | Integer | Required |
address_id | ID of an existing address | Integer | One of these is required if the ticket_group.format is Physical . |
address_attributes | Full address attributes (street_address, extended_address, locality, region, postal_code, country_code ) | Object |
Note – You must provide either an address_id or the address_attributes so that we can advise the shipping carrier where these will ship, in order to properly offer a suggestion.
Examples
Request | Response |
---|---|
POST /v9/shipments/suggestion | |
{ "ticket_group_id":123456789, "address_id":54321 } | { "price":15.0, "name":"Fedex 2 Day", "service_type":"FEDEX_2_DAY", "provider":"FedEx" } |
{ "ticket_group_id":123456789, "address_attributes": { "street_address": "7721 East Gray Road", "extended_address": "Suite 102", "locality": "Scottsdale", "region": "AZ", "postal_code": "85260", "country_code": "US" } } | { "price":15.0, "name":"Fedex 2 Day", "service_type":"FEDEX_2_DAY", "provider":"FedEx" } |