> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gomarketbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel one of the signed-in supplier’s bookings

> The supplier cancels their own booking, exactly as from the MarketBox dashboard: only a SCHEDULED booking, only when its service lets suppliers cancel (403 `PARTICIPANT_ACTION_DISABLED`), and only outside the service’s notice window (409 `NOTICE_WINDOW_PASSED`). Recorded as supplier-initiated, by the signed-in person; a package session goes back on the package; no refund is made. The client and the business are emailed. A booking that is not the supplier’s is a 404, indistinguishable from a missing one. Requires the API key and the supplier’s user token.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/projects/{projectId}/suppliers/me/bookings/{bookingId}/cancel
openapi: 3.0.0
info:
  title: MarketBox 2.0 Open API
  version: 1.0.0
  description: >-
    The MarketBox public API for building booking experiences. Core model:
    create an order, then draw its order items down into bookings. Single
    bookings reference an order item per service line; package bookings draw one
    PACKAGE item down across N sessions. To schedule a package, build a slate
    (POST /availability/package-slate) and book it by slateId (POST
    /orders/{orderId}/package-bookings). See the guides for end-to-end
    walkthroughs.
  contact:
    name: MarketBox support
servers:
  - url: https://apiv2.gomarketbox.com
    description: MarketBox Open API
security:
  - ApiKeyAuth: []
paths:
  /v1/projects/{projectId}/suppliers/me/bookings/{bookingId}/cancel:
    post:
      tags:
        - Supplier plane
      summary: Cancel one of the signed-in supplier’s bookings
      description: >-
        The supplier cancels their own booking, exactly as from the MarketBox
        dashboard: only a SCHEDULED booking, only when its service lets
        suppliers cancel (403 `PARTICIPANT_ACTION_DISABLED`), and only outside
        the service’s notice window (409 `NOTICE_WINDOW_PASSED`). Recorded as
        supplier-initiated, by the signed-in person; a package session goes back
        on the package; no refund is made. The client and the business are
        emailed. A booking that is not the supplier’s is a 404,
        indistinguishable from a missing one. Requires the API key and the
        supplier’s user token.
      parameters:
        - schema:
            type: string
            minLength: 1
            description: >-
              The project (tenant) that owns the resource. Every resource in
              this API is scoped to a project, and your API key is restricted to
              the projects it was issued for — a project outside that scope
              returns 403.
            example: prj_01kv60qgnef2kt3pvqgwmkbzfr
          required: true
          description: >-
            The project (tenant) that owns the resource. Every resource in this
            API is scoped to a project, and your API key is restricted to the
            projects it was issued for — a project outside that scope returns
            403.
          name: projectId
          in: path
        - schema:
            type: string
            minLength: 1
            description: >-
              The booking — one scheduled unit of service occupying supplier
              time.
            example: bk_01kv7q41n2hbqxwm03ymn7bxl9
          required: true
          description: The booking — one scheduled unit of service occupying supplier time.
          name: bookingId
          in: path
      requestBody:
        description: Why
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                reasonCode:
                  type: string
                  enum:
                    - CLIENT_REQUESTED
                    - CLIENT_UNWELL
                    - SUPPLIER_UNAVAILABLE
                    - WEATHER
                    - FACILITY_UNAVAILABLE
                    - BOOKED_IN_ERROR
                    - OTHER
                  description: >-
                    Why the booking is cancelled. Recorded on the booking’s
                    history.
                  example: SUPPLIER_UNAVAILABLE
                note:
                  type: string
                  maxLength: 1000
                  description: >-
                    Optional free text kept on the booking’s history (at most
                    1000 characters). Never emailed.
                  example: Pool closed for maintenance that morning.
              required:
                - reasonCode
      responses:
        '200':
          description: Cancelled booking
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Booking'
                required:
                  - data
        '400':
          description: >-
            Validation error, or (BAD_REQUEST) the booking cannot move to that
            status or its zone is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Missing or invalid API key or user token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: >-
            The API key cannot access this project (FORBIDDEN) or lacks standard
            API access (CAPABILITY_NOT_GRANTED); or the signed-in user has no
            MarketBox account record (FORBIDDEN, "User account not found.
            Complete registration first."); or the signed-in user is not a
            member of the project (NOT_A_MEMBER), their membership has ended
            (MEMBERSHIP_INACTIVE), or the roles they act under lack the route’s
            permission (NO_SUPPLIER_ROLE); or X-MB-Acting-Role names a role they
            do not hold (ACTING_ROLE_NOT_HELD); or the booking’s service does
            not let suppliers do this (PARTICIPANT_ACTION_DISABLED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: >-
            The signed-in user has no supplier record here: no SUPPLIER among
            the roles they act under (NO_SUPPLIER_ROLE), or no single supplier
            record linked to them (SUPPLIER_NOT_LINKED); or no such booking of
            theirs (NOT_FOUND)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '409':
          description: >-
            The booking is not scheduled (BOOKING_NOT_SCHEDULED), changes have
            closed for it (NOTICE_WINDOW_PASSED), or it changed since it was
            read (VERSION_CONFLICT)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - ApiKeyAuth: []
          EndUserBearer: []
components:
  schemas:
    Booking:
      type: object
      properties:
        projectId:
          type: string
        tenantId:
          type: string
        bookingId:
          type: string
        seriesId:
          type: string
          nullable: true
        occurrenceLocalDate:
          type: string
          nullable: true
        isException:
          type: boolean
        supplierId:
          type: string
          nullable: true
        clientId:
          type: string
        packageOrderItemId:
          type: string
          nullable: true
        bookingStartUtc:
          type: string
          format: date-time
        bookingEndUtc:
          type: string
          format: date-time
        bookingTz:
          type: string
        bookingLocalDate:
          type: string
        bookingLocalStartTime:
          type: string
        bookingLocalEndTime:
          type: string
        bookingLocalEndDate:
          type: string
        locale:
          type: string
        attribution:
          type: object
          properties:
            searchId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                The `searchId` of the MarketBox search response the buyer booked
                from — the `X-MB-Search-Id` header / body field of every search
                route. Stored as given; a value MarketBox never issued is kept
                but not trusted.
              example: srch_01k7q3x9h4e8rb2d6m0z5a7c1n
            sessionKey:
              type: string
              minLength: 1
              maxLength: 64
              description: >-
                The same opaque per-session key you send with site events, at
                most 64 characters. Never an email, IP or user id.
              example: sess-example-01
            surface:
              type: string
              enum:
                - home
                - results
                - listing
                - site_search
                - profile
                - widget
                - assistant
                - other
              description: Where on your site the buyer started the purchase.
              example: results
          additionalProperties: false
          description: >-
            Which search and site session this purchase came from. Optional; set
            once on the order and copied onto every booking it funds. See the
            search-log guide, "Booking attribution".
        locationType:
          type: string
          enum:
            - PHYSICAL
            - VIRTUAL
            - TRAVEL_ZONE
        locationId:
          type: string
          nullable: true
        latitude:
          type: number
          nullable: true
        longitude:
          type: number
          nullable: true
        address:
          $ref: '#/components/schemas/Address'
        capacity:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        participantCount:
          type: integer
          minimum: 0
        waitlistCount:
          type: integer
          minimum: 0
        isGroupBooking:
          type: boolean
        status:
          type: string
          enum:
            - SCHEDULED
            - STARTED
            - AWAITING_CONFIRMATION
            - DISPUTED
            - COMPLETED
            - CANCELLED
            - CLIENT_NO_SHOW
            - SUPPLIER_NO_SHOW
            - NO_SHOW
        statusUpdatedAt:
          type: string
          format: date-time
        statusUpdatedBy:
          type: string
        statusUpdatedByCapacity:
          type: string
          enum:
            - ADMIN
            - SUPPLIER
            - CLIENT
            - SYSTEM
            - API
        cancellationReason:
          type: string
          nullable: true
        cancelledBy:
          type: string
          nullable: true
        cancellationInitiatedBy:
          type: string
          enum:
            - CLIENT
            - SUPPLIER
            - BUSINESS
        cancellationReasonCode:
          type: string
          enum:
            - CLIENT_REQUESTED
            - CLIENT_UNWELL
            - SUPPLIER_UNAVAILABLE
            - WEATHER
            - FACILITY_UNAVAILABLE
            - BOOKED_IN_ERROR
            - OTHER
        creditTreatment:
          type: string
          enum:
            - RETURN
            - FORFEIT
            - REFUND_ORIGINAL_PAYMENT
            - NOT_APPLICABLE
        durationOverrideMinutes:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 1440
        durationOverrideReason:
          type: string
          minLength: 1
          maxLength: 500
        counts:
          type: object
          properties:
            services:
              type: integer
              minimum: 0
            notes:
              type: integer
              minimum: 0
            participants:
              type: integer
              minimum: 0
          required:
            - services
            - notes
            - participants
        deleted:
          type: boolean
        version:
          type: integer
          minimum: 0
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        createdBy:
          type: string
        updatedBy:
          type: string
      required:
        - projectId
        - tenantId
        - bookingId
        - supplierId
        - clientId
        - bookingStartUtc
        - bookingEndUtc
        - bookingTz
        - bookingLocalDate
        - bookingLocalStartTime
        - bookingLocalEndTime
        - bookingLocalEndDate
        - locationType
        - locationId
        - latitude
        - longitude
        - address
        - capacity
        - participantCount
        - waitlistCount
        - isGroupBooking
        - status
        - statusUpdatedAt
        - counts
        - deleted
        - version
        - createdAt
        - updatedAt
        - createdBy
        - updatedBy
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
          description: Stable machine-readable error code, e.g. NOT_FOUND.
        message:
          type: string
          description: Human-readable description of what went wrong.
        statusCode:
          type: integer
          description: The HTTP status code of this response.
        requestId:
          type: string
          description: >-
            The id of this request, also returned as the X-Request-Id header.
            Quote it in a support ticket.
      required:
        - code
        - message
        - statusCode
        - requestId
      example:
        code: NOT_FOUND
        message: Booking not found
        statusCode: 404
        requestId: a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10
    Address:
      type: object
      nullable: true
      properties:
        addressOneLine:
          type: string
          minLength: 1
          description: The whole address on one line, as a person would write it.
          example: 10 Main St, Toronto, ON M5V 1A1, Canada
        streetNumber:
          type: string
          minLength: 1
          description: The street number.
          example: '10'
        streetName:
          type: string
          minLength: 1
          description: The street name.
          example: Main St
        city:
          type: string
          minLength: 1
          description: The city or town.
          example: Toronto
        state:
          type: string
          minLength: 1
          description: The state, province or region; an ISO 3166-2 code when one matches.
          example: 'ON'
        country:
          type: string
          minLength: 1
          description: The country; ISO 3166-1 alpha-2, alpha-3 or the English name.
          example: CA
        zipCode:
          type: string
          minLength: 1
          description: The postal or ZIP code, in any national format.
          example: M5V 1A1
        unitNumber:
          type: string
          nullable: true
          description: The unit, suite or apartment, if any.
          example: 4B
      required:
        - addressOneLine
        - streetNumber
        - streetName
        - city
        - state
        - country
        - zipCode
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key minted in the MarketBox dashboard. Scope is restricted to the
        projects you select at creation time. Every route needs the key's
        standard API access (`*`) except `POST /v1/projects/{projectId}/events`,
        which needs `events:write`; a key without `*` is refused with 403
        `CAPABILITY_NOT_GRANTED`.
    EndUserBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The signed-in person's Cognito access token, issued to this
        application's app client. Sent with the API key on the /clients/me and
        /suppliers/me routes.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.