Shipments / Update

Owned by Ian Grabill (Unlicensed)
Last updated: Apr 18, 2024 by J Cobb (Unlicensed)
3 min read
NameShipments Update
DescriptionUpdate a shipment for an existing order
TypePUT
URL/v9/shipments/:id
Credential TypeAPI|User

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 to Transfer (TMMobile or TMMobileLink or FlashSeats) or Eticket

Sellers may change any order to either TMMobile or FlashSeats.

Name
Description
Type
Required
mobile_transfer_type

Defines how the ticket will be transferred. Must be one of:

  • FlashSeats: Will be transferred via FlashSeats/AXS
  • TMMobile: Will be transferred via Ticketmaster or any other provider such as SeatGeek
  • TMMobileLink: A URL will be provided with which the buyer can claim the tickets.
  • Eticket: A PDF or QR Code will be provided


Previously tm_mobile_shipment_type was used for this as well. It is still supported but all new integrations should use mobile_transfer_type.

stringRequired (for this operation) 
PUT /v9/shipments/1234567Response

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: 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 sellerstringRequired 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).HashRequired 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).HashRequired when type is LocalPickup
pickup_time_range
The pickup timestringRequired when type is LocalPickup
pickup_instructions
Additional notes on location and any other pickup detailsstringOptional
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.

NameDescriptionTypeRequired
ship_to_name
Contact name of the Attendee/CustomerstringRequired 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 type is LocalPickup

notes
Any additional requests or commentsstringOptional
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.