Long Description
Update a shipment for an existing order. The JSON body of the request will vary depending on the what is being done and if it is the seller or the buyer doing it.
NOTE: Despite this being a PUT the original shipment will be deleted and a new shipment with a new ID will be returned as the response body.
SELLER: Change a Shipment From Eticket to Transfer (TMMobile or FlashSeats)
Sellers may change an order with a shipment.type of eticket to either TMMobile or FlashSeats.
Name | Description | Type | Required | Prerequisite |
|---|---|---|---|---|
mobile_transfer_type | Defines how the ticket will be transferred. Must be one of:
| string | Required (for this operation) | type must be Eticket |
| PUT /v9/shipments/1234567 | Response |
|---|---|
OR OR | Response {
"id": 5192586,
"url": "/shipment/5192586",
"type": "TMMobile",
"email_address": {
"id": 4227710,
"url": null,
"address": "michaelstarr@example.com",
"label": null,
"updated_at": "2021-05-16T22:15:11Z"
},
}
(Response has been trimmed for brevity.) |
SELLER: Change a Shipment From Tbd to Transfer (TMMobile or TMMobileLink)
Orders that are expected to be transferred begin with a default shipment.type of Tbd after order creation and will remain so until the seller decides on the final shipment method (TMMobile or TMMobileLink). See also: HOW TO: Automate Flash & TM Mobile Transfers
Name | Description | Type | Required | Prerequisite |
|---|---|---|---|---|
tm_mobile_shipment_type | Defines how the ticket will be transferred. Must be one of:
| string | Required (for this operation) | type must be Tbd |
PUT /v9/shipments/1234567 | Response |
|---|---|
OR | Response {
"id": 5192586,
"url": "/shipment/5192586",
"type": "TMMobile",
"email_address": {
"id": 4227710,
"url": null,
"address": "michaelstarr@example.com",
"label": null,
"updated_at": "2021-05-16T22:15:11Z"
},
}
(Response has been trimmed for brevity.) |
SELLER: Provide Local Pickup Information
After an order with a shipment.type of LocalPickup has been accepted the Seller must provide information on where to pick up the tickets.
Name | Description | Type | Required |
|---|---|---|---|
ship_from_name | Contact name of the seller | string | Required when type is LocalPickup |
ship_from_phone_number_attributes | Attributes of a new phone number to create and use as a contact number for the seller. A new Phone Number will be created (see example below). | Hash | Required when type is LocalPickup |
ship_from_address_attributes | Attributes of a new address to create and use for the pickup location. A new Address will be created (see example below). | Hash | Required when type is LocalPickup |
pickup_time_range | The pickup time | string | Required when type is LocalPickup |
pickup_instructions | Additional notes on location and any other pickup details | string | Optional |
PUT /v9/shipments/1234567 | Response |
|---|---|
Response {
"id": 5184368,
"url": "/shipments/5184368",
"type": "LocalPickup",
"ship_from_name": "Michael Starr",
"ship_from_address": {
"id": 63965284,
"label": null,
"name": "Michael Starr",
"street_address": "333 Washington St",
"extended_address": "Suite 302",
"locality": "Jersey City",
"region": "NJ",
"postal_code": "07307",
"country_code": "US"
},
"ship_from_phone_number": {
"id": 25954226,
"url": "/clients//phone_numbers/25954226",
"label": "Cell",
"country_code": "+1",
"number": "2015555555",
"extension": "",
"updated_at": "2021-09-06T15:17:54Z"
}
"pickup_time_range": "2 Hours before game",
"pickup_instructions": "Call and I will come downstairs",
}
(Response has been trimmed for brevity.) If both parties have already updated the shipment with their Local Pickup details, the shipment will move to a Delivered state and can no longer be updated. To make changes you will need to contact support. |
BUYER: Provide Local Pickup Information
After an order with a shipment.type of LocalPickup has been accepted the Buyer must provide information to the seller to help arrange the pick up of the tickets.
| Name | Description | Type | Required |
|---|---|---|---|
ship_to_name | Contact name of the Attendee/Customer | string | Required when type is LocalPickup |
phone_number_attributes | Attributes of a new phone number to create and use as a contact number for the Attendee/Customer. A new Phone Number will be created (see example below). | Hash | Required when |
notes | Any additional requests or comments | string | Optional |
PUT /v9/shipments/1234567 | Response |
|---|---|
Response {
"id": 5184368,
"url": "/shipments/5184368",
"type": "LocalPickup",
"ship_to_name": "Ralph Saenz",
"phone_number": {
"label": "iPhone",
"country_code": "+1",
"number": "2025555555",
"extension": null
},
"notes": "I will be in a Saints jersey"
}
(Response has been trimmed for brevity.) If both parties have already updated the shipment with their Local Pickup details, the shipment will move to a Delivered state and can no longer be updated. To make changes you will need to contact support. |