Versions Compared

Old Version 24

changes.mady.by.user J Cobb

Saved on

compared with

New Version Current

changes.mady.by.user J Cobb

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
labelapi_docs_shipments


NameShipments Update
DescriptionUpdate a shipment for an existing order
TypePUT
URL/v9/shipments/:id
Credential TypeAPI|User


...

Info

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 an order with a shipment.type of eticket to any order to either TMMobile or FlashSeats.

Prerequisitetype must be Eticket
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) 


Name
Description
Type
Required
Prerequisite
tm_mobile_shipment_type

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

  • 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.
stringRequired (for this operation) type must be Tbd
PUT /v9/shipments/1234567
Response
Paste code macro
languagejson
{"tm_mobile_shipment_type":"TMMobile"}

OR

Paste code macro
languagejson
{"tm_mobile_shipment
PUT /v9/shipments/1234567Response


Paste code macro
languagejson
{"mobile_transfer_type":"TMMobile"}

OR

Paste code macro
languagejson
{"mobile_transfer_type":"FlashSeats"}

OR

Paste code macro
languagejson
{"tm_mobile_shipment_type":"TMMobileLink"}
Code Block
languagejs
themeMidnight
firstline1
titleResponse
{
  "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

mobile_transfer_type":"TMMobileLink"}



Code Block
languagejs
themeMidnight
firstline1
titleResponse
{
  "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

...