ACME Developers

TABLE OF CONTENTS

• List barcodes
• Get a barcode
• Add barcodes
• Update barcodes
• Deactivate barcodes
• JSON Objects

Summary

This architecture leverages the optionality of barcodes that don't always get used, to reduce stress on our system, and doesn't create an order or ticket until the barcode is scanned. 

Assigning a collaborator to a venue will include creating an org and tenant user in the venue with the tenant user being assigned an api key.  The name of the org and tenant user will match the name of the collaborator.

Each API call will be for a specific tenant and include the api key assigned to that user.

List barcodes

Get v2/b2b/barcodes

Parameters

• createdAfter   ISO8601 date that you want barcodes created after
• createdBefore   ISO8601 date that you want barcodes created before
• updatedAfter   ISO8601 date that you want barcodes updated after
• updatedBefore   ISO8601 date that you want barcodes updated before
• usedAfter   ISO8601 date that you want barcodes scanned after - USEAGE NOT YET WORKING
• usedBefore   ISO8601 date that you want barcodes scanned before - USEAGE NOT YET WORKING
• eventTemplateId   The id of the event template you want barcodes of
• eventId   The id of the event you want barcodes of
• ticketTypeId    The ticket type id you want barcodes of
• status  The status that you want barcodes of (converted, new, voided, error) - USEAGE NOT YET WORKING
• customerEmail   The email of the customer you want the barcodes for
• customerId   The id of the customer you want the barcodes for
• externalOrderNumber   The external order number, if provided.
• pageSize   The number of barcodes you want returned, default 100
• page   The page you want the barcodes for
• sortDirection   Either 'asc' or 'desc'
• sortField   What to sort the barcodes on (createdOn, updatedOn, usedOn, barcode, externalOrderNumber, eventTemplateId).

Returns

A paginated list of Barcode JSON objects

Examples

GET /v2/b2b/barcodes?createdAfter=2019-04-18T00:00:00Z&createdBefore=2019-04-19T00:00:00Z  -H "x-acme-api-key:[key]"

GET /v2/b2b/barcodes?externalOrderNumber=123  -H "x-acme-api-key:[key]"

Get a barcode

Get v2/b2b/barcodes/{barcode}

Returns

A Barcode JSON object

Examples

GET /v2/b2b/barcodes/123  -H "x-acme-api-key:[key]"

Add barcodes

POST v2/b2b/barcodes

Body

A list of Barcode JSON objects being added into the ACME system.

Returns

The resulting list of Barcode JSON objects with the id and created time filled in.

POST Examples

Add three barcodes

Update barcodes

PUT v2/b2b/barcodes

Body

This API takes a single barcode object: it is recommended that you modify an object returned from a POST or GET. Ensure that the "id" comes from an existing barcode object.

Returns

When successful, the API will return a 200 and the barcode object as updated.

Example

PUT /v2/b2b/barcodes  -H "x-acme-api-key:[key]"

{
        "id": :1234-1234-12345",
        "collaboratorId": 9,
        "eventTemplateId": "1234-1234-12345",
        "eventId": "678-678-6789",
        "ticketTypeId": "567-567-5678",
        "email": "mickey@acmeticketing.com",
        "firstName": "Modified",
        "lastName": "Name",
        "barcode": "567-1230-0002",
        "externalOrderNumber": "10002"
}

Deactivate barcodes

Put v2/b2b/barcodes/deactivations

Body

A list of barcodes to be removed

Returns

     The Barcode JSON objects that were deleted

Example

    Delete three barcodes  

JSON Objects

Barcode Object

Barcode List