snapcasterDevelopers

    API reference · Types

    MarketplaceError

    Part of the error responses of 37 operations.

    Type: object

    Example

    Generated Schema example: Generated MarketplaceError
    {
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string"
  }
}

    Fields

    success boolean required

    Whether the operation completed as requested.

    Constraints: allowed values: false

    error object required

    Error details for a failed request.

    Show child fieldsHide child fields
    error.code string required

    Stable public error code the platform can branch on.

    Constraints: allowed values: UNAUTHORIZED, INVALID_REQUEST, UNSUPPORTED_API_VERSION, IDEMPOTENCY_KEY_REQUIRED, IDEMPOTENCY_CONFLICT, REQUEST_IN_PROGRESS, STALE_SNAPSHOT, SELLER_SOURCE_EXCLUSIVE, SUBSCRIPTION_EXCLUDES_ORDERS, BATCH_TOO_LARGE, RATE_LIMITED, ORDER_NOT_FOUND, CANCELLATION_REQUEST_NOT_FOUND, REQUEST_ALREADY_OPEN, CANCELLATION_REQUEST_LIMIT_REACHED, CANCELLATION_NOT_ALLOWED, INVALID_TRANSITION, ORDER_LINE_AMBIGUOUS, ORDER_ADDITION_PAYMENT_IN_FLIGHT, TEST_PURCHASE_NOT_AVAILABLE, TEST_PURCHASE_NOT_FOUND, TEST_PURCHASE_LIMIT_EXCEEDED, TEST_LISTING_NOT_BROWSABLE, INSUFFICIENT_STOCK, SHIPPING_OPTION_INVALID, CORRECTION_NOT_ALLOWED, CORRECTION_CHANGES_DELIVERY_REGION, CORRECTION_UNCHANGED, ADDRESS_VERIFICATION_NOT_RETRYABLE, ADDRESS_VERIFICATION_RETRY_TOO_SOON, ORDER_CHANGE_REQUEST_NOT_FOUND, ORDER_CHANGE_REQUEST_NOT_PENDING, ORDER_CHANGE_REQUEST_NOT_ALLOWED, WEBHOOK_ENDPOINT_NOT_REGISTERED, ORDER_ADDITION_NOT_ELIGIBLE, ORDER_ADDITION_SKU_UNKNOWN, ORDER_ADDITION_REQUEST_NOT_FOUND, ORDER_ADDITION_REQUEST_NOT_PENDING, ORDER_ADDITION_OFFER_NOT_FOUND, ORDER_ADDITION_OFFER_NOT_SENT, ORDER_ADDITION_OFFER_NOT_OUTSTANDING, ORDER_ADDITION_OFFER_ALREADY_OUTSTANDING, ORDER_ADDITION_OFFER_LISTING_MISSING, ORDER_ADDITION_OFFER_PRICE_ABOVE_LISTING, ORDER_ADDITION_OFFER_PRICE_CHANGED, ORDER_ADDITION_OFFER_INSUFFICIENT_STOCK, ORDER_ADDITION_OFFER_SHIPPING_CAPACITY, ORDER_ADDITION_OFFER_SHIPPING_OPTION_INVALID, ORDER_ADDITION_OFFER_SHIPPING_NOT_REQUIRED, ORDER_ADDITION_OFFER_SHIPPING_DOWNGRADE, ORDER_ADDITION_OFFER_SHIPPING_UNSTATED, ORDER_ADDITION_OFFER_SHIPPING_CHANGED, ORDER_ADDITION_OFFER_BELOW_MINIMUM, ORDER_ADDITION_OFFER_TAX_UNRESOLVED, ORDER_CHANGE_REQUEST_ALREADY_PENDING, SUPPORT_CASE_CLOSED, SUPPORT_CASE_WINDOW_CLOSED

    error.message string required

    A human-readable explanation of the result.

    error.details unknown

    Additional details to help diagnose the result.

    Used by