The imin Platform
2.0.0
2.0.0
  • Introduction to the imin Platform
  • Using the Platform
    • imin's Platform Products
    • Authentication
    • Our Platform Data
      • Understanding Responses
      • Namespaces and Extensions
      • Defensive Data Consumption
      • Mocking the Interface
  • platform products
    • Search
      • imin Events API
        • Events API Reference
        • Virtual & Physical Sessions
        • Concepts
          • EventSeries
          • ScheduledSessions and eventSchedules
          • Activities and Collections
            • Activities
            • Activity Concept Collections
          • Accessibility Support
          • Prices
        • Filters
          • Modes
          • Age Ranges
          • Dates and Times
          • Activities and Concept Collections
          • High Frequency Sessions
      • imin Facilities API
        • Query Parameter Search
          • Mandatory Query Parameters
            • mode=discovery-geo
            • mode=upcoming-slots
          • Optional Query Parameters
        • ByID Search
          • FacilityUse By-ID
          • Slot By-ID
        • FacilityUses and IndividualFacilityUses
        • Slots
        • Facilities Slot Booking
      • imin Places API [BETA]
        • Example Request & Response
    • Firehose
      • Introduction to the Firehose
      • Accessing the Firehose
      • Firehose Usage Policy & Restrictions
      • Firehose and Search
      • Bookable Firehose Feeds
      • Bookable Sellers Feed
      • Attribution Catalog Endpoint
    • Live Timetables
      • Pre-Requisites: Open Data Feeds
      • The Onboarding Process
        • 1. Ensuring your Data Offers the Best User Experience
        • 2. Setting up and Embedding your First Timetable
        • 3. Setting up the Rest of your Timetables
        • 4. Activating Booking via Guest Checkout
      • Features Available Upon Request
      • Styling the Live Timetables
      • FAQs
    • Data Dashboard
  • incorporating book and pay
    • imin Branded Checkout
      • Introduction
      • Setup
        • Information We Require From You
        • Actions You Need to Complete
      • Authenticated Checkout
        • Testing [BETA]
        • 👪Group Booking [BETA]
      • Standalone Checkout
      • Firehose and Checkout [BETA]
        • Loading the Checkout via Firehose
    • imin Booking Platform
      • Customer Account Management
        • Create Customer Account
        • Update Customer Account
        • Get Customer Account
        • Delete Customer Account
        • Example Scenario
        • Payment Card Management
        • Linked Accounts
        • Entitlement
          • Evidence Requests
          • Entitlement Pricing in Search
          • Entitlement Pricing in Checkout
        • Access Pass
        • Webhooks
      • Orders
        • Order History
        • Order (by ID)
        • Cancellations & Refunds
      • Upcoming OrderItems
      • Receipt (by ID)
  • imin and booking systems
    • Seller Onboarding
      • API
  • HINTS & TIPS
    • Get the Best Out of Search
      • Displaying Schedule Information
      • URLs and Offering a Call to Action
      • Searching by Activity
      • Your Search Results and HighFrequencySessions
      • Customer Specific Images
  • Info for Data Publishers
    • Your RPDE Feed & the imin Platform [BETA]
      • Providing Places Data [BETA]
      • Providing Schedule Information [BETA]
Powered by GitBook
On this page
  1. incorporating book and pay
  2. imin Booking Platform

Upcoming OrderItems

Upcoming OrderItems that are being attended by a given customer.

PreviousCancellations & RefundsNextReceipt (by ID)

Last updated 2 years ago

Each OrderItem is a session or booked out facility that the customer has booked using Checkout and will be going to. OrderItems are sorted by date with the earliest appearing first in the list.

This is useful to provide customers with a schedule of what they are attending in the near future and actions for each OrderItem e.g. .

Headers

X-API-KEY must be provided when making the request to this endpoint. This authorizes you to access the API for your customers.

Request

GET https://book.imin.co/api/v2/order-items?customerIdentifier={iminCustomerIdentifer}&page={page}

This request must be made Server-side. Otherwise, it would be possible to view the secret API key with a browser.

The customerIdentifier parameter is the imin customer identifier that was created when you called our endpoint with the customer in question

The page parameter specifies which page of Orders is returned

Response

An example 200 response for a session or event OrderItem looks like the following:

{
  "@context": [
    "https://openactive.io/",
    "https://schema.imin.co/",
    "https://openactive.io/ns-beta"
  ],
  "id": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page=1",
  "type": "imin:RestrictedCollection",
  "imin:totalItems": 19,
  "view": {
    "id": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page=1",
    "type": "PartialCollectionView",
    "first": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page=1",
    "last": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page=192",
    "imin:currentPage": 1,
    "imin:itemsPerPage": 10,
    "imin:totalPages": 1,
    "urlTemplate": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page={page}",
    "next": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page=2"
  },
  "imin:item": [{
    "type": "OrderItem",
    "id": "https://book.imin.co/api/v2/orders/0bac05e5-b207-4794-80b8-6c94211643c5/order-items/abcd",
    "identifier": "abcd",
    "orderedItem": {
      "type": "ScheduledSession",
      "id": "https://search.imin.co/events-api/v2/scheduled-sessions/http%3A%2F%2Fopendata.kinetic-insight.com%2Fapi%2Ffeeds%2Fscheduled-sessions%2F00000000000000000269",
      "identifier": "http://opendata.kinetic-insight.com/api/feeds/scheduled-sessions/00000000000000000269",
      "startDate": "2020-04-16T10:00:00+00:00",
      "endDate": "2020-04-16T11:00:00+00:00",
      "superEvent": {
        "type": "SessionSeries",
        "location": {
          "type": "Place",
          "identifier": "2476",
          "name": "test venue",
          "url": "http://opendata.kinetic-insight.com/venues/2476",
          "geo": {
            "type": "GeoCoordinates",
            "latitude": 51.4290485,
            "longitude": -0.1692925
          },
          "address": {
            "type": "PostalAddress",
            "addressLocality": " 3 Dale Street",
            "postalCode": "m1 1ba",
            "addressRegion": " Manchester",
            "addressCountry": "GB",
            "streetAddress": "Flat 3"
          }
        },
        "superEvent": {
          "type": "EventSeries",
          "name": "test sss",
          "organizer": {
            "type": "Organization",
            "id": "http://kinetic-insight.com",
            "name": "kinetic-insight",
            "sameAs": [
              "https://www.facebook.com/kineticinsight/",
              "https://twitter.com/kineticinsight"
            ],
            "url": "http://kinetic-insight.com",
            "logo": {
              "type": "ImageObject",
              "url": "http://kinetic-insight.com/wp-content/uploads/2017/05/KI-LOGO-WEB-K-ONLY-.png"
            },
            "telephone": "0800 808 9004",
            "email": "support@kinetic-insight.com"
          }
        }
      },
      "duration": "PT1H",
      "maximumAttendeeCapacity": 10,
      "remainingAttendeeCapacity": 9
    },
    "orderItemStatus": "https://openactive.io/OrderItemConfirmed",
    "acceptedOffer": {
      "type": "Offer",
      "id": "http://opendata.kinetic-insight.com/api/feeds/offers/ki-adult",
      "name": "ki-adult",
      "price": 10,
      "priceCurrency": "GBP",
      "latestCancellationBeforeStartDate": "P1D",
      "validFromBeforeStartDate": "P6D"
      "allowCustomerCancellationFullRefund": true
    },
    "unitTaxSpecification": [{
      "type": "TaxChargeSpecification",
      "name": "VAT",
      "price": 0,
      "priceCurrency": "GBP",
      "rate": 0
    }],
    "accessPass": [{
      "@type": "Barcode",
      "text": "EXT12345678901234567"
    }],
    "imin:order": {
      "type": "Order",
      "id": "https://book.imin.co/api/v2/orders/0bac05e5-b207-4794-80b8-6c94211643c5"
    },
    "imin:isPresentlyCancellable": true
  }]
}

An example 200 response for a facility slot OrderItem looks like the following:

{
  "@context": [
    "https://openactive.io/",
    "https://schema.imin.co/",
    "https://openactive.io/ns-beta"
  ],
  "id": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page=1",
  "type": "imin:RestrictedCollection",
  "imin:totalItems": 19,
  "view": {
    "id": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page=1",
    "type": "PartialCollectionView",
    "first": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page=1",
    "last": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page=192",
    "imin:currentPage": 1,
    "imin:itemsPerPage": 10,
    "imin:totalPages": 1,
    "urlTemplate": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page={page}",
    "next": "https://book.imin.co/api/v2/order-items?customerIdentifier=1234&page=2"
  },
  "imin:item": [{
    "id": "https://book.imin.co/api/v2/order-items/https%3A%2F%2Fseller.com%2Fapi%2Fopenbooking%2Forders%2F56191d36-6f18-4a37-a1f8-86675144d0d1%23%2ForderedItems%2F0282c289-0c38-48fc-b9a5-93655fef1d9a",
    "type": "OrderItem",
    "position": 0,
    "identifier": "https://seller.com/api/openbooking/orders/56191d36-6f18-4a37-a1f8-86675144d0d1#/orderedItems/0282c289-0c38-48fc-b9a5-93655fef1d9a",
    "imin:order": {
      "id": "https://book.imin.co/api/v2/orders/56191d36-6f18-4a37-a1f8-86675144d0d1",
      "type": "Order",
      "identifier": "56191d36-6f18-4a37-a1f8-86675144d0d1"
    },
    "orderedItem": {
      "id": "https://search.imin.co/facilities-api/v2/slots/https%3A%2F%2Fseller.com%2Fapi%2Fidentifiers%2Ffacility-uses%2F444-226%2Ffacility-use-slots%2Fb7f8f13f-237a-4fc5-b3d6-37837d86c1c8",
      "type": "Slot",
      "offers": [
        {
          "id": "https://seller.com/api/identifiers/facility-uses/444-226/facility-use-slots/b7f8f13f-237a-4fc5-b3d6-37837d86c1c8#/offers/36",
          "name": "seller Adult",
          "type": "Offer",
          "price": 10,
          "identifier": 36,
          "priceCurrency": "GBP",
          "ageRestriction": {
            "type": "QuantitativeValue",
            "minValue": 0
          },
          "openBookingInAdvance": "oa:Optional",
          "openBookingPrepayment": "oa:Required",
          "imin:membershipRequired": false,
          "validFromBeforeStartDate": "P4DT17H40M",
          "latestCancellationBeforeStartDate": "PT2H",
          "allowCustomerCancellationFullRefund": true
        },
        {
          "id": "https://seller.com/api/identifiers/facility-uses/444-226/facility-use-slots/b7f8f13f-237a-4fc5-b3d6-37837d86c1c8#/offers/451",
          "name": "seller Junior",
          "type": "Offer",
          "price": 10,
          "identifier": 451,
          "priceCurrency": "GBP",
          "ageRestriction": {
            "type": "QuantitativeValue",
            "minValue": 0
          },
          "openBookingInAdvance": "oa:Optional",
          "openBookingPrepayment": "oa:Required",
          "imin:membershipRequired": false,
          "validFromBeforeStartDate": "P4DT17H40M",
          "latestCancellationBeforeStartDate": "PT2H",
          "allowCustomerCancellationFullRefund": true
        },
        {
          "id": "https://seller.com/api/identifiers/facility-uses/444-226/facility-use-slots/b7f8f13f-237a-4fc5-b3d6-37837d86c1c8#/offers/6247",
          "name": "MCRactive Free Swimming 60+",
          "type": "Offer",
          "price": 10,
          "identifier": 6247,
          "priceCurrency": "GBP",
          "ageRestriction": {
            "type": "QuantitativeValue",
            "minValue": 60
          },
          "openBookingInAdvance": "oa:Unavailable",
          "openBookingPrepayment": "oa:Required",
          "imin:membershipRequired": false,
          "validFromBeforeStartDate": "P1W"
        }
      ],
      "endDate": "2021-11-04T14:20:00+00:00",
      "duration": "PT40M",
      "startDate": "2021-11-04T13:40:00+00:00",
      "identifier": "https://seller.com/api/identifiers/facility-uses/444-226/facility-use-slots/b7f8f13f-237a-4fc5-b3d6-37837d86c1c8",
      "facilityUse": {
        "id": "https://search.imin.co/facilities-api/v2/facility-uses/seller-FacilityUse-13719",
        "url": "https://www.seller.org.uk/leisure-centre/manchester/hough-end",
        "name": "Squash Court - 40mins",
        "type": "FacilityUse",
        "@context": [
          "https://openactive.io/",
          "https://ns.imin.co/"
        ],
        "activity": [
          {
            "id": "https://openactive.io/activity-list#b7845b8a-4c0c-4a8f-93d3-d41d62eec889",
            "type": "Concept",
            "inScheme": "https://openactive.io/activity-list",
            "prefLabel": "Squash"
          }
        ],
        "location": {
          "geo": {
            "type": "GeoCoordinates",
            "latitude": 51.491888,
            "longitude": 0.077221
          },
          "url": "https://www.seller.org.uk/leisure-centre/manchester/hough-end",
          "name": "Head Office",
          "type": "Place",
          "address": {
            "type": "PostalAddress",
            "postalCode": "SE18 6SX",
            "addressRegion": "Greater Manchester",
            "streetAddress": "Middlegate House",
            "addressCountry": "GB",
            "addressLocality": "Manchester",
            "imin:fullAddress": "Head Office, Middlegate House, Manchester, SE18 6SX"
          },
          "telephone": "02083175000",
          "identifier": "6c9ba378-6540-4931-b601-f59d03b47fd3"
        },
        "provider": {
          "id": "https://seller.com/api/identifiers/seller",
          "name": "Seller",
          "type": "Organization",
          "email": "applicationsupport@seller.org",
          "taxMode": "oa:TaxGross",
          "isOpenBookingAllowed": true
        },
        "identifier": "seller-FacilityUse-13719",
        "_providerId": "seller",
        "imin:dataSource": {
          "type": "WebAPI",
          "identifier": "seller"
        },
        "beta:bookingChannel": [
          "beta:OnlinePrepayment"
        ]
      },
      "maximumUses": 12,
      "remainingUses": 11,
      "imin:aggregateOffer": {
        "type": "imin:AggregateOffer",
        "publicAdult": {
          "id": "https://seller.com/api/identifiers/facility-uses/444-226/facility-use-slots/b7f8f13f-237a-4fc5-b3d6-37837d86c1c8#/offers/36",
          "type": "AggregateOffer",
          "price": 10,
          "priceCurrency": "GBP",
          "imin:membershipRequired": false,
          "validFromBeforeStartDate": "P4DT17H40M"
        },
        "publicJunior": {
          "id": "https://seller.com/api/identifiers/facility-uses/444-226/facility-use-slots/b7f8f13f-237a-4fc5-b3d6-37837d86c1c8#/offers/451",
          "type": "AggregateOffer",
          "price": 10,
          "priceCurrency": "GBP",
          "imin:membershipRequired": false,
          "validFromBeforeStartDate": "P4DT17H40M"
        }
      }
    },
    "acceptedOffer": {
      "id": "https://seller.com/api/identifiers/facility-uses/444-226/facility-use-slots/b7f8f13f-237a-4fc5-b3d6-37837d86c1c8#/offers/36",
      "name": "sellet Booking Adult",
      "type": "Offer",
      "price": 10,
      "identifier": "36",
      "priceCurrency": "GBP",
      "ageRestriction": {
        "type": "QuantitativeValue",
        "maxValue": 100,
        "minValue": 16
      },
      "validFromBeforeStartDate": "P5DT16H40M",
      "latestCancellationBeforeStartDate": "PT0S",
      "allowCustomerCancellationFullRefund": true
    },
    "accessPass": [{
      "@type": "Barcode",
      "text": "EXT12345678901234567"
    }],
    "orderQuantity": 1,
    "imin:isPresentlyCancellable": true
  }]
}

Key fields:

  • view shows the total number of pages and helpful pages like previous, next and last.

  • imin:item is the array of Order items relating to the customer, ordered by startDate in ascending order.

  • orderedItem is the ScheduledSession or FacilityUseSlot for that OrderItem.

Please note: the structure of Scheduled Sessions and Slots orderItems is different. For example, when displaying the name of a booked activity to the user, you will need to first determine if the orderItem is a ScheduledSession or Slot, and then use the appropriate both to extract the name value.

imin:order is the parent Order relating to that OrderItem. Go to this id URL to find other OrderItems bought in the same Order or to .

cancelling
Create Customer
view the Receipt