Update a line-item

PUT 
/api/v8/partner/documents/:document_id/line-items/:line_item_id

Veryfi's Update a Document by ID endpoint allows you to change a Document that Veryfi's Machine Learning models have already processed. This feature will enable users to update Documents previously processed by Veryfi to ensure data extraction accuracy. Updating a Document is especially useful for correcting mistakes and updating information over time. By changing a processed Document, Veryfi's Machine Learning models can re-learn the updated information, allowing them to stay accurate and up-to-date.

Request

Path Parameters

document_id int64required

The unique identifier of the document.

line_item_id int64required

The unique identifier of the line item.

application/json

Body

category object

The category is taken from the line item with the same SKU and/or description. Otherwise from the root category field.

anyOf

MOD1

string

DetailedClassPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

country_of_origin object

The country of manufacture, production, design, or brand origin where the product comes from.

anyOf

MOD1

string

PUTLineItemCountryOfOriginFieldType

value stringrequired

Possible values: [UM, PE, AZ, AI, CN, KE, ML, DE, TO, TR, AL, CR, VE, GE, AQ, MA, OM, GS, PL, EG, IE, LI, LC, TK, IO, JP, IM, KI, CC, AN, TD, IS, EE, CI, GL, GR, AT, TH, PH, CM, CF, MQ, MR, CU, LB, GD, NL, TM, AX, AD, KZ, UY, TT, AG, IT, RS, RU, FM, FJ, GN, US, PM, WS, AO, BN, PF, TW, LR, NE, CH, SC, UZ, ES, IR, IN, PT, NP, BB, NF, TG, MN, GF, VN, KG, SB, EC, BD, HN, LV, SK, GI, ZA, LS, AM, GG, HK, SG, HU, CL, BH, CO, VA, LK, NO, MT, AS, MU, PG, LA, SN, GM, VG, RW, MH, HM, AU, TZ, PA, SM, SO, TJ, TC, GA, FK, FI, NI, ZW, BE, HT, EH, KY, AR, BI, KH, LU, MO, MP, RO, YE, MV, IL, NA, GB, VC, YT, NZ, SA, CV, DO, SV, FO, JO, NC, GT, BV, VU, PR, ER, BL, DZ, MX, KP, DJ, VI, SH, MG, AW, ME, BG, TV, TL, AF, PN, NU, IQ, BW, FR, PS, PY, CG, KM, LT, CK, KR, MW, MZ, BR, MC, ST, QA, GQ, GW, SZ, CD, KN, GU, TN, MY, NR, CA, SJ, CZ, KW, MK, SY, HR, BJ, BO, BA, MD, TF, MM, CY, GH, JE, MF, DM, SL, SI, BZ, SR, DK, WF, BY, LY, GP, UG, PK, AE, BM, NG, BS, CX, GY, ID, PW, SD, ET, BT, JM, SE, BF, ZM, RE, MS, UA]

date object

The date found on the document and associated with the line item in ISO 8601 format.

anyOf

MOD1

string

DetailedPUTDateField

value daterequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

description object

The product or service's extracted name or description excluding date and price.

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

discount_price object

The lower price after discount.

anyOf

MOD1

number

DetailedPUTFloatField

value numberrequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

discount_rate object

The discount percentage that was applied to the line item.

anyOf

MOD1

number

DetailedPUTFloatField

value numberrequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

discount object

The amount deducted from the total price for the line item.

anyOf

MOD1

number

DetailedPUTFloatField

value numberrequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

end_date object

A service end date identified for the line item. An end date could be a flight arrival date or hotel departure date in ISO 8601 format.

anyOf

MOD1

string

DetailedPUTDateField

value daterequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

hsn object

The Harmonized System Nomenclature (HSN) found for the line item.

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

order integer
lot object

The batch or lot number for the line item.

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

price object

The unit price for the line item.

anyOf

MOD1

number

DetailedPUTFloatField

value numberrequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

quantity object

The amount or number of units for the line item. This value is computable.

anyOf

MOD1

number

DetailedPUTFloatField

value numberrequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

reference object

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

section object

A grouping indicated by formatted text on the receipt or invoice.

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

sku object

The Stock Keeping Unit (SKU) is the unique code associated with the product for the line item.

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

start_date object

A service start date identified for the line item. A start date could be a flight departure date or hotel arrival date in ISO 8601 format.

anyOf

MOD1

string

DetailedPUTDateField

value daterequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

tags string[]

Possible values: non-empty

A user-defined list of identifiers that help to categorize or flag particular types of line items.

tax_code object

The classification of goods and services for tax purposes for the line item.

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

manufacturer object

The name of the manufacturer of the product for the line item.

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

tax_rate object

The percent at which the individual or corporation is taxed.

anyOf

MOD1

number

DetailedPUTFloatField

value numberrequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

tax object

The amount at which the individual or corporation is taxed for the product on this line item.

anyOf

MOD1

number

DetailedPUTFloatField

value numberrequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

total object

The total price for this line item. This value is computable.

anyOf

MOD1

number

DetailedPUTFloatField

value numberrequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

subtotal object

New, added 2023-07-10. The total of a set of numbers that will later be added to another set of numbers, such as tip and tax. This value is computable.

anyOf

MOD1

number

DetailedPUTFloatField

value numberrequired

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

type object

The classification of the product. The line type predicted by Veryfi, e.g. food.

anyOf

MOD1

string

PUTLineItemTypeFieldType

value stringrequired

Possible values: [room, tax, parking, service, fee, delivery, product, food, alcohol, tobacco, transportation, fuel, refund, discount, payment, giftcard]

unit_of_measure object

The unit of measurement for this line item.

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

upc object

The Universal Product Code (UPC), European Article Number (EAN), or Global Trade Item Number (GTIN) found for the line item on this document will be placed in this field.

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

weight object

The weight of the item for the line item. Usually found on logistic invoices.

anyOf

MOD1

string

DetailedPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

Responses

200

Document's line-item

application/json

Schema

Schema

id integerrequired

The unique number created to identify the Line Item object.

order integerrequired

The value indicating the position of where the line item appears on the document.

tags string[]

Possible values: non-empty

A user-defined list of identifiers that help to categorize or flag particular types of line items.

text stringrequired

Possible values: non-empty

The complete text returned for the line item, including prices, dates, etc.

type stringrequired

Possible values: [room, tax, parking, service, fee, delivery, product, food, alcohol, tobacco, transportation, fuel, refund, discount, payment, giftcard]

The classification of the product. The line type predicted by Veryfi, e.g. food.

date date

The date found on the document and associated with the line item in ISO 8601 format.

description stringrequired

Possible values: non-empty

The product or service's extracted name or description excluding date and price.

full_description string

Possible values: non-empty

The item text including dates, weight, etc.

normalized_description string

Possible values: non-empty

The line item description with expanded words

discount_price number

The lower price after discount.

discount_rate number

The discount percentage that was applied to the line item.

discount number

The date found on the document and associated with the line item in ISO 8601 format.

price number

The unit price for the line item.

quantity number

The amount or number of units for the line item. This value is computable.

reference string

Possible values: non-empty

section string

Possible values: non-empty

A grouping indicated by formatted text on the receipt or invoice.

sku string

Possible values: non-empty

The Stock Keeping Unit (SKU) is the unique code associated with the product for the line item.

tax_rate number

The percent at which the individual or corporation is taxed.

tax number

The amount at which the individual or corporation is taxed for the product on this line item.

total number

The total price for this line item. This value is computable.

subtotal number

New, added 2023-07-10. The total of a set of numbers that will later be added to another set of numbers, such as tip and tax. This value is computable.

unit_of_measure string

Possible values: non-empty

The unit of measurement for this line item.

category string

Possible values: non-empty

The category is taken from the line item with the same SKU and/or description. Otherwise from the root category field.

country_of_origin string

Possible values: [UM, PE, AZ, AI, CN, KE, ML, DE, TO, TR, AL, CR, VE, GE, AQ, MA, OM, GS, PL, EG, IE, LI, LC, TK, IO, JP, IM, KI, CC, AN, TD, IS, EE, CI, GL, GR, AT, TH, PH, CM, CF, MQ, MR, CU, LB, GD, NL, TM, AX, AD, KZ, UY, TT, AG, IT, RS, RU, FM, FJ, GN, US, PM, WS, AO, BN, PF, TW, LR, NE, CH, SC, UZ, ES, IR, IN, PT, NP, BB, NF, TG, MN, GF, VN, KG, SB, EC, BD, HN, LV, SK, GI, ZA, LS, AM, GG, HK, SG, HU, CL, BH, CO, VA, LK, NO, MT, AS, MU, PG, LA, SN, GM, VG, RW, MH, HM, AU, TZ, PA, SM, SO, TJ, TC, GA, FK, FI, NI, ZW, BE, HT, EH, KY, AR, BI, KH, LU, MO, MP, RO, YE, MV, IL, NA, GB, VC, YT, NZ, SA, CV, DO, SV, FO, JO, NC, GT, BV, VU, PR, ER, BL, DZ, MX, KP, DJ, VI, SH, MG, AW, ME, BG, TV, TL, AF, PN, NU, IQ, BW, FR, PS, PY, CG, KM, LT, CK, KR, MW, MZ, BR, MC, ST, QA, GQ, GW, SZ, CD, KN, GU, TN, MY, NR, CA, SJ, CZ, KW, MK, SY, HR, BJ, BO, BA, MD, TF, MM, CY, GH, JE, MF, DM, SL, SI, BZ, SR, DK, WF, BY, LY, GP, UG, PK, AE, BM, NG, BS, CX, GY, ID, PW, SD, ET, BT, JM, SE, BF, ZM, RE, MS, UA]

The country of manufacture, production, design, or brand origin where the product comes from.

custom_fields object

A user-defined dictionary that contains all the custom fields generated by applying specific rules and regular expressions to the extracted data.

product_details object[]
Product lookup details
Array [
]
end_date date

A service end date identified for the line item. An end date could be a flight arrival date or hotel departure date in ISO 8601 format.

gross_total number

The line item total before deductions.

hsn string

Possible values: non-empty

The Harmonized System Nomenclature (HSN) found for the line item.

lot string

Possible values: non-empty

The batch or lot number for the line item.

start_date date

A service start date identified for the line item. A start date could be a flight departure date or hotel arrival date in ISO 8601 format.

tax_code string

Possible values: non-empty

The classification of goods and services for tax purposes for the line item.

manufacturer string

Possible values: non-empty

The name of the manufacturer of the product for the line item.

net_total number

The line item total after deductions.

upc string

Possible values: non-empty

The Universal Product Code (UPC), European Article Number (EAN), or Global Trade Item Number (GTIN) found for the line item on this document will be placed in this field.

weight string

Possible values: non-empty

The weight of the item for the line item. Usually found on logistic invoices.

Example (from schema)

{
  "id": 0,
  "order": 0,
  "tags": [
    "string"
  ],
  "text": "string",
  "type": "room",
  "date": "2024-07-27",
  "description": "string",
  "full_description": "string",
  "normalized_description": "string",
  "discount_price": 0,
  "discount_rate": 0,
  "discount": 0,
  "price": 0,
  "quantity": 0,
  "reference": "string",
  "section": "string",
  "sku": "string",
  "tax_rate": 0,
  "tax": 0,
  "total": 0,
  "subtotal": 0,
  "unit_of_measure": "string",
  "category": "string",
  "country_of_origin": "UM",
  "custom_fields": {},
  "product_details": [
    {}
  ],
  "end_date": "2024-07-27",
  "gross_total": 0,
  "hsn": "string",
  "lot": "string",
  "start_date": "2024-07-27",
  "tax_code": "string",
  "manufacturer": "string",
  "net_total": 0,
  "upc": "string",
  "weight": "string"
}

400

User error

application/json

Schema

Schema

oneOf

MALFORMED_PARAMETERS

status string

Default value: fail

error string

Default value: Malformed parameters

details undefined[]

Default value: [object Object]

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

503

Service is temporaly unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporaly unavailable. Please try again later

Example (from schema)

{}

default

OperationStatus

application/json

Schema

Schema

status string

Default value: fail

error stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "error": "string",
  "details": [
    {}
  ]
}

Loading...