GET v1/Shops/{shopId}/InvoiceStatuses

Get a list with all available Invoice Statuses, for given shop.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shopId

The id of the shop.

integer

Required.

Body Parameters

None.

Response Information

Resource Description

A list of the InvoiceStatusBasicInfo objects.

Collection of InvoiceStatusBasicInfo
NameDescriptionTypeAdditional information
Id

Gets or sets the identifier.

integer

Required

BaseInvoiceStatusId

Gets or sets the base invoice status identifier.

integer

None.

InvoiceStatusTypeId

Gets or sets the invoice status type identifier.

integer

None.

Name

Gets or sets the name.

string

Required

Max length: 50

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "BaseInvoiceStatusId": 2,
    "InvoiceStatusTypeId": 3,
    "Name": "sample string 4"
  },
  {
    "Id": 1,
    "BaseInvoiceStatusId": 2,
    "InvoiceStatusTypeId": 3,
    "Name": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfInvoiceStatusBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <InvoiceStatusBasicInfo>
    <Id>1</Id>
    <BaseInvoiceStatusId>2</BaseInvoiceStatusId>
    <InvoiceStatusTypeId>3</InvoiceStatusTypeId>
    <Name>sample string 4</Name>
  </InvoiceStatusBasicInfo>
  <InvoiceStatusBasicInfo>
    <Id>1</Id>
    <BaseInvoiceStatusId>2</BaseInvoiceStatusId>
    <InvoiceStatusTypeId>3</InvoiceStatusTypeId>
    <Name>sample string 4</Name>
  </InvoiceStatusBasicInfo>
</ArrayOfInvoiceStatusBasicInfo>