Fulfill PDF

Fulfill PDF

post

Fulfill PDF

Allows an authenticated seller to fulfill pdfs to orders. Note: Use this API for listings created with PDF stocktype

Resource URL

https://api.stubcloudprod.com/sellers/sales /pdf/v3/{saleId}

Header Parameters


Name Values Description
Authorization
(required)

To generate an access token, use the [generateToken API](https://developer.stubhub.com/oauth/apis/post/accesstoken). Note that you will need to add a 'Bearer ' prefix to your access token. Otherwise, you'll get an 'Invalid Access Token' error

Content-Type
(required)

multipart/form-data

Content-Disposition
(required)

This header indicates the data that is passed in the HTTP request for each subpart of the multipart/form-data. In this API call, there are two subparts. - The first subpart contains data in JSON format about the listing itself: 1. The ticket row/seat numbers. 2. The name of the PDF file for each ticket in the listing. Each PDF file is a ticket that contains complete information about the Section, Row, Seat, and the type of the ticket. - The second subpart references the PDF file object for each ticket that is uploaded to the listing. **Note**: This API allows the user to upload multiple files at one time. **Example 1:** Fulfilling an order of two PDF files for two regular tickets (Row E, Seats 151 and 152). The following sample code in this request contains these headers: - The required header `Content-Type: multipart/form-data` means the request is composed of multiple subparts. In this example, the first subpart contains data in JSON format about the 'listing' itself (the row/seat for the ticket and the PDF file object, file1, to upload for the seat in the listing). - The required header `Content-Disposition: form-data; name="name"` indicates the each subpart, referencing either the 'listing' json or the reference to the PDF file object that is going to be uploaded to the listing. ``` POST https://api.stubcloudprod.com/sellers/sales/pdf/v3/{saleId} HTTP/1.1 Authentication: Bearer your-access-token Accept-Encoding: gzip,deflate Content-Type: multipart/form-data; boundary="----=_Part_8_1845002416.1475115847148" Accept: application/json Host: api.stubcloudprod.com Connection: Keep-Alive ------=_Part_8_1845002416.1475115847148 Content-Disposition: form-data; name="sale" Content-Transfer-Encoding: 8bit { "products": [ { "row": "E", "seat": "151", "name":"V2.pdf" }, { "row": "E", "seat": "152", "name":"V1.pdf" } ] } ------=_Part_8_1845002416.1475115847148 Content-Type: application/pdf; Content-Transfer-Encoding: binary Content-Disposition: form-data; name="V1.pdf" ------=_Part_8_1845002416.1475115847148 Content-Type: application/pdf; Content-Transfer-Encoding: binary Content-Disposition: form-data; name="V2.pdf" ------=_Part_8_1845002416.1475115847148-- ```

Body Parameters


Name Values Description
sale
(required)

Attachments


Name Value Description
fileName

Name of PDF file(s) to upload for the seat(s). You can upload a single PDF file or multiple PDF files. For a single PDF file, the file size limit for uploading is 1 MB. For up to 10 PDF files, the total file size limit must not exceed 10 MB. The API tries to upload as many PDFs that are associated with the ticket order. If a PDF fails to upload, the upload operation continues to fulfill the remainder of the ticket order but it reports an error in the response payload.

Request Body

An listing object specifying products in listing and their associated pdf filename. Example: { 'products': [{ 'row': '1', 'seat': '1', 'name': 'fieldNameForPDF' }] }

saleId The sale ID to fulfill null true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    Bad Request This indicates bad request and the response will contain the errors in the following format: ``` { "errors": [ { "code": "fulfillment.pdf.file.invalidOrderStatus", "description": "order status is invalid", "data": { "orderStatus": "Cancelled", "orderId": "1234567" } } ] } ```

  • 401
    401

    Not authorized to access the API

  • 403
    403

    Forbidden

  • 404
    404

    Not Found

  • 500
    500

    inventory.listings.systemError

Resource Summary

Security

Content Type

multipart/form-data

Category

Fulfillment

Working...