Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Warning

A warning returned by the web service.

Hierarchy

  • Warning

Index

Properties

Readonly code

code: string

This value is a machine-readable code identifying the warning. See the web service documentation for the current list of of warning codes.

Readonly inputPointer

inputPointer: string

A JSON Pointer to the input field that the warning is associated with. For instance, if the warning was about the billing city, this would be /billing/city. If it was for the price in the second shopping cart item, it would be /shopping_cart/1/price.

Readonly input_pointer

input_pointer: string

Readonly warning

warning: string

This property provides a human-readable explanation of the warning. The description may change at any time and should not be matched against.

Generated using TypeDoc