---
title: "MarketplaceRequest"
url: "https://api-docs.centraldispatch.com/apis/listings-api-v2-2-0-0/versions/e78b419e-84e4-4e17-a33f-0966c7b6015f/schemas/MarketplaceRequest"
---

> Full API specification: https://api-docs.centraldispatch.com/apis/listings-api-v2-2-0-0/versions/e78b419e-84e4-4e17-a33f-0966c7b6015f.md

# MarketplaceRequest

Details of a marketplace.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Listing API
  version: 2.0.0
servers:
  - url: https://marketplace-api.centraldispatch.com
    description: Production server
components:
  schemas:
    MarketplaceRequest:
      type: object
      properties:
        marketplaceId:
          type: integer
          description: "The ID of the Central Dispatch Marketplace. There are three types
            of Marketplaces:\r

            \r

            - **Public**: The public Marketplace ID is `10000`.\r

            - **Test**: Test Marketplace IDs will be provided to you by Central
            Dispatch.\r

            - **Private**: Private Marketplace IDs will be provided to you by
            Central Dispatch, if necessary."
          format: int32
          example: 10000
        digitalOffersEnabled:
          type: boolean
          description: "Indicates whether digital offers are enabled for this Marketplace
            on this listing. Digital offers functionality is currently only
            available for select private Marketplaces. When `true` the following
            are required: \r

            \ - `sla` is required. \r

            \ - `stops` address is required.\r

            \ - `vehicles` all vehicles must have VIN."
          default: false
          example: true
        searchable:
          type: boolean
          description: "Controls whether the listing appears in Marketplace search
            results. Allows listings to be posted but not publicly searchable.
            When `true`: listing is visible and searchable on this Marketplace.
            When `false`: listing is hidden from Marketplace search."
          default: false
          example: true
        offersAutoAcceptEnabled:
          type: boolean
          description: Allows carrriers to digitially accept an offer. The button will be
            visible for this Marketplace on this listing. Requires
            `digitalOffersEnabled` to be true.
          default: false
          example: false
        autoDispatchOnOfferAccepted:
          type: boolean
          description: Automatically creates a dispatch when a carrier accepts an offer on
            the listing. If not specified, the value defaults to the
            configuration of the marketplace the listing is posted to. If
            explicitly provided, the supplied value takes precedence.
          default: false
          nullable: true
          example: true
        predispatchNotes:
          maxLength: 500
          type: string
          description: "Provides general preparation instructions for shipments. This
            should not contain sensitive data as it is made available prior to
            acceptance of terms by a carrier.\r

            <b>Rules</b>: This information will always be visible to carriers,
            and it will no longer be editable once the load is dispatched."
          nullable: true
          example: In order to pick up the keys you will have to walk through a lot with a
            big dog that protects it, he's chained but will bark at you.
        customersExcludedFromOffers:
          type: array
          items:
            type: string
            format: uuid
          description: A collection of customer IDs excluded from offers. Maximum count of
            200.
          nullable: true
          example:
            - d5c62b14-cbd1-11ee-9a0e-0242ac110002
            - 157a16f0-503d-4256-ba60-a4876e8eb9bb
        makeOffersEnabled:
          type: boolean
          description: Allows carriers to make an offer on the listing. The button will be
            visible for this Marketplace on this listing. Requires
            `digitalOffersEnabled` to be true. Defaults to the value of
            `digitalOffersEnabled` if null.
          nullable: true
          example: true
      description: Details of a marketplace.
```