eBay · Schema

OfferResponse

This type is used by the response payload of the createOffer and updateOffer calls. The offerId field contains the unique identifier for the offer if the offer is successfully created by the createOffer call. The warnings field contains any errors and/or warnings that may have been triggered by the call.

Note: The offerId value is only returned with a successful createOffer call. This field will not be returned in the updateOffer response.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
offerId string The unique identifier of the offer that was just created with a createOffer call. It is not returned if the createOffer call fails to create an offer. This identifier
warnings array This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur.
View JSON Schema on GitHub

JSON Schema

ebay-offerresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OfferResponse",
  "title": "OfferResponse",
  "type": "object",
  "properties": {
    "offerId": {
      "type": "string",
      "description": "The unique identifier of the offer that was just created with a <strong>createOffer</strong> call. It is not returned if the <strong>createOffer</strong> call fails to create an offer. This identifier will be needed for many offer-related calls. <p> <span class=\"tablenote\"><strong>Note:</strong> The <strong>offerId</strong> value is only returned with a successful <strong>createOffer</strong> call. This field will not be returned in the <strong>updateOffer </strong> response.</span></p>"
    },
    "warnings": {
      "type": "array",
      "description": "This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur.",
      "items": {
        "$ref": "#/components/schemas/Error"
      }
    }
  },
  "description": "This type is used by the response payload of the <strong>createOffer</strong> and <strong>updateOffer</strong> calls. The <strong>offerId</strong> field contains the unique identifier for the offer if the offer is successfully created by the <strong>createOffer</strong> call. The <strong>warnings</strong> field contains any errors and/or warnings that may have been triggered by the call. <p> <span class=\"tablenote\"><strong>Note:</strong> The <strong>offerId</strong> value is only returned with a successful <strong>createOffer</strong> call. This field will not be returned in the <strong>updateOffer </strong> response.</span></p>"
}