POST api/Vipps/category

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Address	string	None.
MerchantSerial	string	None.
UserId	string	None.
Secret	string	None.
AppId	string	None.
EcommerceSubscriptionKey	string	None.
ClientId	string	None.
ClientSecret	string	None.
AccessTokenKey	string	None.
OrderId	integer	None.
OldOrderId	integer	None.
Amount	integer	None.
PosID	integer	None.
PersonID	integer	None.
Text	string	None.
PosVersionNumber	string	None.
WebhooksOrderObject	Order	None.

Request Formats

application/json, text/json

Sample:

{
  "Address": "sample string 1",
  "MerchantSerial": "sample string 2",
  "UserId": "sample string 3",
  "Secret": "sample string 4",
  "AppId": "sample string 5",
  "EcommerceSubscriptionKey": "sample string 6",
  "ClientId": "sample string 7",
  "ClientSecret": "sample string 8",
  "AccessTokenKey": "sample string 9",
  "OrderId": 10,
  "OldOrderId": 11,
  "Amount": 12,
  "PosID": 13,
  "PersonID": 14,
  "Text": "sample string 15",
  "PosVersionNumber": "sample string 16",
  "WebhooksOrderObject": {
    "ReceiptNo": "sample string 1",
    "ReceiptFormatted": "sample string 2",
    "ReceiptUrl": "sample string 3",
    "OrderNo": "sample string 4",
    "OrderType": 0,
    "CreatedDateTime": "2025-09-07T03:06:59.0993892+00:00",
    "UpdatedDateTime": "2025-09-07T03:06:59.0993892+00:00",
    "Comment": "sample string 6",
    "PaymentLines": [
      {
        "Type": "sample string 1",
        "SubType": "sample string 2",
        "Currency": "sample string 3",
        "CurrencyTendered": 1.0,
        "TxRef": "sample string 4",
        "Text": "sample string 5",
        "Amount": 6.0,
        "RowId": "sample string 7"
      },
      {
        "Type": "sample string 1",
        "SubType": "sample string 2",
        "Currency": "sample string 3",
        "CurrencyTendered": 1.0,
        "TxRef": "sample string 4",
        "Text": "sample string 5",
        "Amount": 6.0,
        "RowId": "sample string 7"
      }
    ],
    "OrderLines": [
      {
        "RowId": "sample string 1",
        "GTIN": "sample string 2",
        "ExternalSKU": "sample string 3",
        "Brand": "sample string 4",
        "Name": "sample string 5",
        "Variant": "sample string 6",
        "Number": "sample string 7",
        "Colour": "sample string 8",
        "Size": "sample string 9",
        "SizeText": "sample string 10",
        "Group": "sample string 11",
        "Season": "sample string 12",
        "ImageUrl": "sample string 13",
        "Quantity": 14.0,
        "Price": 15.0,
        "VAT": 16.0,
        "VATPercent": 17.0,
        "FullPrice": 18.0,
        "Discount": 19.0,
        "DiscountPercent": 20.0,
        "ReceiptLabel": "sample string 21",
        "Status": 0,
        "ShipFromOnlineStore": true,
        "Reasons": [
          {
            "Code": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Code": "sample string 1",
            "Name": "sample string 2"
          }
        ]
      },
      {
        "RowId": "sample string 1",
        "GTIN": "sample string 2",
        "ExternalSKU": "sample string 3",
        "Brand": "sample string 4",
        "Name": "sample string 5",
        "Variant": "sample string 6",
        "Number": "sample string 7",
        "Colour": "sample string 8",
        "Size": "sample string 9",
        "SizeText": "sample string 10",
        "Group": "sample string 11",
        "Season": "sample string 12",
        "ImageUrl": "sample string 13",
        "Quantity": 14.0,
        "Price": 15.0,
        "VAT": 16.0,
        "VATPercent": 17.0,
        "FullPrice": 18.0,
        "Discount": 19.0,
        "DiscountPercent": 20.0,
        "ReceiptLabel": "sample string 21",
        "Status": 0,
        "ShipFromOnlineStore": true,
        "Reasons": [
          {
            "Code": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Code": "sample string 1",
            "Name": "sample string 2"
          }
        ]
      }
    ],
    "ShipmentInfo": "sample string 7",
    "ReservationLengthInHours": 1,
    "FulfillmentLocation": {
      "StockId": 1,
      "StockName": "sample string 2",
      "PosId": 3,
      "PersonId": 4,
      "ShipmentInfo": [
        "sample string 1",
        "sample string 2"
      ],
      "Shipments": [
        {
          "Id": "sample string 1",
          "ShipmentInfo": [
            "sample string 1",
            "sample string 2"
          ],
          "Items": [
            {
              "RowId": "sample string 1",
              "GTIN": "sample string 2",
              "ExternalSKU": "sample string 3"
            },
            {
              "RowId": "sample string 1",
              "GTIN": "sample string 2",
              "ExternalSKU": "sample string 3"
            }
          ]
        },
        {
          "Id": "sample string 1",
          "ShipmentInfo": [
            "sample string 1",
            "sample string 2"
          ],
          "Items": [
            {
              "RowId": "sample string 1",
              "GTIN": "sample string 2",
              "ExternalSKU": "sample string 3"
            },
            {
              "RowId": "sample string 1",
              "GTIN": "sample string 2",
              "ExternalSKU": "sample string 3"
            }
          ]
        }
      ]
    },
    "Store": {
      "StoreExtId": "sample string 1",
      "StoreName": "sample string 2",
      "OrganizationNumber": "sample string 3",
      "PosId": 4,
      "PosName": "sample string 5",
      "SalesPerson": "sample string 6",
      "Currency": "sample string 7",
      "Address": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "CompanyName": "sample string 3",
        "Address1": "sample string 4",
        "Address2": "sample string 5",
        "City": "sample string 6",
        "Province": "sample string 7",
        "PostalCode": "sample string 8",
        "Country": "sample string 9",
        "CountryCode": "sample string 10",
        "Comment": "sample string 11"
      }
    },
    "Customer": {
      "Email": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "CompanyName": "sample string 4",
      "TaxId": "sample string 5",
      "PhoneCountryPrefix": "sample string 6",
      "Phone": "sample string 7",
      "Address": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "CompanyName": "sample string 3",
        "Address1": "sample string 4",
        "Address2": "sample string 5",
        "City": "sample string 6",
        "Province": "sample string 7",
        "PostalCode": "sample string 8",
        "Country": "sample string 9",
        "CountryCode": "sample string 10",
        "Comment": "sample string 11"
      }
    },
    "ShippingAddress": {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "CompanyName": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "City": "sample string 6",
      "Province": "sample string 7",
      "PostalCode": "sample string 8",
      "Country": "sample string 9",
      "CountryCode": "sample string 10",
      "Comment": "sample string 11"
    },
    "VATTotal": 8.0,
    "Total": 9.0,
    "Status": 0
  }
}

application/xml, text/xml

Sample:

<VippsRequestObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VippsApi2.Models">
  <AccessTokenKey>sample string 9</AccessTokenKey>
  <Address>sample string 1</Address>
  <Amount>12</Amount>
  <AppId>sample string 5</AppId>
  <ClientId>sample string 7</ClientId>
  <ClientSecret>sample string 8</ClientSecret>
  <EcommerceSubscriptionKey>sample string 6</EcommerceSubscriptionKey>
  <MerchantSerial>sample string 2</MerchantSerial>
  <OldOrderId>11</OldOrderId>
  <OrderId>10</OrderId>
  <PersonID>14</PersonID>
  <PosID>13</PosID>
  <PosVersionNumber>sample string 16</PosVersionNumber>
  <Secret>sample string 4</Secret>
  <Text>sample string 15</Text>
  <UserId>sample string 3</UserId>
  <WebhooksOrderObject xmlns:d2p1="http://schemas.datacontract.org/2004/07/FrontSystems.DataContracts.OmniChannel">
    <d2p1:Comment>sample string 6</d2p1:Comment>
    <d2p1:CreatedDateTime>2025-09-07T03:06:59.0993892+00:00</d2p1:CreatedDateTime>
    <d2p1:Customer>
      <d2p1:Address>
        <d2p1:Address1>sample string 4</d2p1:Address1>
        <d2p1:Address2>sample string 5</d2p1:Address2>
        <d2p1:City>sample string 6</d2p1:City>
        <d2p1:Comment>sample string 11</d2p1:Comment>
        <d2p1:CompanyName>sample string 3</d2p1:CompanyName>
        <d2p1:Country>sample string 9</d2p1:Country>
        <d2p1:CountryCode>sample string 10</d2p1:CountryCode>
        <d2p1:FirstName>sample string 1</d2p1:FirstName>
        <d2p1:LastName>sample string 2</d2p1:LastName>
        <d2p1:PostalCode>sample string 8</d2p1:PostalCode>
        <d2p1:Province>sample string 7</d2p1:Province>
      </d2p1:Address>
      <d2p1:CompanyName>sample string 4</d2p1:CompanyName>
      <d2p1:Email>sample string 1</d2p1:Email>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone>sample string 7</d2p1:Phone>
      <d2p1:PhoneCountryPrefix>sample string 6</d2p1:PhoneCountryPrefix>
      <d2p1:TaxId>sample string 5</d2p1:TaxId>
    </d2p1:Customer>
    <d2p1:FulfillmentLocation>
      <d2p1:PersonId>4</d2p1:PersonId>
      <d2p1:PosId>3</d2p1:PosId>
      <d2p1:ShipmentInfo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:ShipmentInfo>
      <d2p1:Shipments xmlns:d4p1="http://schemas.datacontract.org/2004/07/FrontSystems.DataContracts.OmniChannel.Shipment">
        <d4p1:ShipmentDetails>
          <d4p1:Id>sample string 1</d4p1:Id>
          <d4p1:Items>
            <d4p1:ShipmentItem>
              <d4p1:ExternalSKU>sample string 3</d4p1:ExternalSKU>
              <d4p1:GTIN>sample string 2</d4p1:GTIN>
              <d4p1:RowId>sample string 1</d4p1:RowId>
            </d4p1:ShipmentItem>
            <d4p1:ShipmentItem>
              <d4p1:ExternalSKU>sample string 3</d4p1:ExternalSKU>
              <d4p1:GTIN>sample string 2</d4p1:GTIN>
              <d4p1:RowId>sample string 1</d4p1:RowId>
            </d4p1:ShipmentItem>
          </d4p1:Items>
          <d4p1:ShipmentInfo xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d4p1:ShipmentInfo>
        </d4p1:ShipmentDetails>
        <d4p1:ShipmentDetails>
          <d4p1:Id>sample string 1</d4p1:Id>
          <d4p1:Items>
            <d4p1:ShipmentItem>
              <d4p1:ExternalSKU>sample string 3</d4p1:ExternalSKU>
              <d4p1:GTIN>sample string 2</d4p1:GTIN>
              <d4p1:RowId>sample string 1</d4p1:RowId>
            </d4p1:ShipmentItem>
            <d4p1:ShipmentItem>
              <d4p1:ExternalSKU>sample string 3</d4p1:ExternalSKU>
              <d4p1:GTIN>sample string 2</d4p1:GTIN>
              <d4p1:RowId>sample string 1</d4p1:RowId>
            </d4p1:ShipmentItem>
          </d4p1:Items>
          <d4p1:ShipmentInfo xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d4p1:ShipmentInfo>
        </d4p1:ShipmentDetails>
      </d2p1:Shipments>
      <d2p1:StockId>1</d2p1:StockId>
      <d2p1:StockName>sample string 2</d2p1:StockName>
    </d2p1:FulfillmentLocation>
    <d2p1:OrderLines>
      <d2p1:OrderLine>
        <d2p1:Brand>sample string 4</d2p1:Brand>
        <d2p1:Colour>sample string 8</d2p1:Colour>
        <d2p1:Discount>19</d2p1:Discount>
        <d2p1:DiscountPercent>20</d2p1:DiscountPercent>
        <d2p1:ExternalSKU>sample string 3</d2p1:ExternalSKU>
        <d2p1:FullPrice>18</d2p1:FullPrice>
        <d2p1:GTIN>sample string 2</d2p1:GTIN>
        <d2p1:Group>sample string 11</d2p1:Group>
        <d2p1:ImageUrl>sample string 13</d2p1:ImageUrl>
        <d2p1:Name>sample string 5</d2p1:Name>
        <d2p1:Number>sample string 7</d2p1:Number>
        <d2p1:Price>15</d2p1:Price>
        <d2p1:Quantity>14</d2p1:Quantity>
        <d2p1:Reasons>
          <d2p1:OrderLineReason>
            <d2p1:Code>sample string 1</d2p1:Code>
            <d2p1:Name>sample string 2</d2p1:Name>
          </d2p1:OrderLineReason>
          <d2p1:OrderLineReason>
            <d2p1:Code>sample string 1</d2p1:Code>
            <d2p1:Name>sample string 2</d2p1:Name>
          </d2p1:OrderLineReason>
        </d2p1:Reasons>
        <d2p1:ReceiptLabel>sample string 21</d2p1:ReceiptLabel>
        <d2p1:RowId>sample string 1</d2p1:RowId>
        <d2p1:Season>sample string 12</d2p1:Season>
        <d2p1:ShipFromOnlineStore>true</d2p1:ShipFromOnlineStore>
        <d2p1:Size>sample string 9</d2p1:Size>
        <d2p1:SizeText>sample string 10</d2p1:SizeText>
        <d2p1:Status>UnHandled</d2p1:Status>
        <d2p1:VAT>16</d2p1:VAT>
        <d2p1:VATPercent>17</d2p1:VATPercent>
        <d2p1:Variant>sample string 6</d2p1:Variant>
      </d2p1:OrderLine>
      <d2p1:OrderLine>
        <d2p1:Brand>sample string 4</d2p1:Brand>
        <d2p1:Colour>sample string 8</d2p1:Colour>
        <d2p1:Discount>19</d2p1:Discount>
        <d2p1:DiscountPercent>20</d2p1:DiscountPercent>
        <d2p1:ExternalSKU>sample string 3</d2p1:ExternalSKU>
        <d2p1:FullPrice>18</d2p1:FullPrice>
        <d2p1:GTIN>sample string 2</d2p1:GTIN>
        <d2p1:Group>sample string 11</d2p1:Group>
        <d2p1:ImageUrl>sample string 13</d2p1:ImageUrl>
        <d2p1:Name>sample string 5</d2p1:Name>
        <d2p1:Number>sample string 7</d2p1:Number>
        <d2p1:Price>15</d2p1:Price>
        <d2p1:Quantity>14</d2p1:Quantity>
        <d2p1:Reasons>
          <d2p1:OrderLineReason>
            <d2p1:Code>sample string 1</d2p1:Code>
            <d2p1:Name>sample string 2</d2p1:Name>
          </d2p1:OrderLineReason>
          <d2p1:OrderLineReason>
            <d2p1:Code>sample string 1</d2p1:Code>
            <d2p1:Name>sample string 2</d2p1:Name>
          </d2p1:OrderLineReason>
        </d2p1:Reasons>
        <d2p1:ReceiptLabel>sample string 21</d2p1:ReceiptLabel>
        <d2p1:RowId>sample string 1</d2p1:RowId>
        <d2p1:Season>sample string 12</d2p1:Season>
        <d2p1:ShipFromOnlineStore>true</d2p1:ShipFromOnlineStore>
        <d2p1:Size>sample string 9</d2p1:Size>
        <d2p1:SizeText>sample string 10</d2p1:SizeText>
        <d2p1:Status>UnHandled</d2p1:Status>
        <d2p1:VAT>16</d2p1:VAT>
        <d2p1:VATPercent>17</d2p1:VATPercent>
        <d2p1:Variant>sample string 6</d2p1:Variant>
      </d2p1:OrderLine>
    </d2p1:OrderLines>
    <d2p1:OrderNo>sample string 4</d2p1:OrderNo>
    <d2p1:OrderType>Unknown</d2p1:OrderType>
    <d2p1:PaymentLines>
      <d2p1:PaymentLine>
        <d2p1:Amount>6</d2p1:Amount>
        <d2p1:Currency>sample string 3</d2p1:Currency>
        <d2p1:CurrencyTendered>1</d2p1:CurrencyTendered>
        <d2p1:RowId>sample string 7</d2p1:RowId>
        <d2p1:SubType>sample string 2</d2p1:SubType>
        <d2p1:Text>sample string 5</d2p1:Text>
        <d2p1:TxRef>sample string 4</d2p1:TxRef>
        <d2p1:Type>sample string 1</d2p1:Type>
      </d2p1:PaymentLine>
      <d2p1:PaymentLine>
        <d2p1:Amount>6</d2p1:Amount>
        <d2p1:Currency>sample string 3</d2p1:Currency>
        <d2p1:CurrencyTendered>1</d2p1:CurrencyTendered>
        <d2p1:RowId>sample string 7</d2p1:RowId>
        <d2p1:SubType>sample string 2</d2p1:SubType>
        <d2p1:Text>sample string 5</d2p1:Text>
        <d2p1:TxRef>sample string 4</d2p1:TxRef>
        <d2p1:Type>sample string 1</d2p1:Type>
      </d2p1:PaymentLine>
    </d2p1:PaymentLines>
    <d2p1:ReceiptFormatted>sample string 2</d2p1:ReceiptFormatted>
    <d2p1:ReceiptNo>sample string 1</d2p1:ReceiptNo>
    <d2p1:ReceiptUrl>sample string 3</d2p1:ReceiptUrl>
    <d2p1:ReservationLengthInHours>1</d2p1:ReservationLengthInHours>
    <d2p1:ShipmentInfo>sample string 7</d2p1:ShipmentInfo>
    <d2p1:ShippingAddress>
      <d2p1:Address1>sample string 4</d2p1:Address1>
      <d2p1:Address2>sample string 5</d2p1:Address2>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:Comment>sample string 11</d2p1:Comment>
      <d2p1:CompanyName>sample string 3</d2p1:CompanyName>
      <d2p1:Country>sample string 9</d2p1:Country>
      <d2p1:CountryCode>sample string 10</d2p1:CountryCode>
      <d2p1:FirstName>sample string 1</d2p1:FirstName>
      <d2p1:LastName>sample string 2</d2p1:LastName>
      <d2p1:PostalCode>sample string 8</d2p1:PostalCode>
      <d2p1:Province>sample string 7</d2p1:Province>
    </d2p1:ShippingAddress>
    <d2p1:Status>UnHandled</d2p1:Status>
    <d2p1:Store>
      <d2p1:Address>
        <d2p1:Address1>sample string 4</d2p1:Address1>
        <d2p1:Address2>sample string 5</d2p1:Address2>
        <d2p1:City>sample string 6</d2p1:City>
        <d2p1:Comment>sample string 11</d2p1:Comment>
        <d2p1:CompanyName>sample string 3</d2p1:CompanyName>
        <d2p1:Country>sample string 9</d2p1:Country>
        <d2p1:CountryCode>sample string 10</d2p1:CountryCode>
        <d2p1:FirstName>sample string 1</d2p1:FirstName>
        <d2p1:LastName>sample string 2</d2p1:LastName>
        <d2p1:PostalCode>sample string 8</d2p1:PostalCode>
        <d2p1:Province>sample string 7</d2p1:Province>
      </d2p1:Address>
      <d2p1:Currency>sample string 7</d2p1:Currency>
      <d2p1:OrganizationNumber>sample string 3</d2p1:OrganizationNumber>
      <d2p1:PosId>4</d2p1:PosId>
      <d2p1:PosName>sample string 5</d2p1:PosName>
      <d2p1:SalesPerson>sample string 6</d2p1:SalesPerson>
      <d2p1:StoreExtId>sample string 1</d2p1:StoreExtId>
      <d2p1:StoreName>sample string 2</d2p1:StoreName>
    </d2p1:Store>
    <d2p1:Total>9</d2p1:Total>
    <d2p1:UpdatedDateTime>2025-09-07T03:06:59.0993892+00:00</d2p1:UpdatedDateTime>
    <d2p1:VATTotal>8</d2p1:VATTotal>
  </WebhooksOrderObject>
</VippsRequestObject>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'VippsRequestObject'.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>