POST api/orders

Creates an order for a new subscription of any type.

Request Information

URI Parameters

None.

Body Parameters

An object containing information about the order to create. Note that some fields can be omitted depending on the subscription category.

OrderCreationRequest

Name	Type	Additional information
OrderDetails	Collection of OrderItem	None.
PaymentId	integer	None.
OrderPaymentAccountSourceId	string	None.
OrderPaymentDescription	string	None.
NewBillingAddress	AdditionalAddress	None.
NewShippingAddress	AdditionalAddress	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderDetails": [
    {
      "CategoryId": 1,
      "VoluntaryTopupAmount": 2.0,
      "OrderDetail": {
        "DonorAccountNumber": "sample string 1",
        "DonorContractTypePrepaid": true,
        "DonorOperatorCode": "sample string 2",
        "IccId": "sample string 3",
        "NpSubscriberId": "sample string 4",
        "NumberPorting": true,
        "NumberReservationCode": "sample string 6",
        "PhoneNumber": "sample string 7",
        "SimTypeId": 8,
        "TempNumberStartDate": "2025-04-28T00:58:52.698315+02:00",
        "TemporaryPhoneNumber": "sample string 9",
        "BankInformationId": 1,
        "CreatedBy": "sample string 10",
        "CustomerId": 11,
        "Date": "2025-04-28T00:58:52.698315+02:00",
        "InitialBalance": 1,
        "OrderGroupGuid": "a7d160f7-c91a-4511-a413-a9748adfaadf",
        "PackageProvisioningCode": 13,
        "PayerAddressId": 1,
        "PaymentInformationId": 1,
        "PricePlanProvisioningCode": 14,
        "ProductProvisioningCodes": [
          1,
          2
        ],
        "SalesCode": "sample string 15",
        "ShippingAddressId": 1,
        "SubscriptionTypeId": 16,
        "TopUpAmount": 1,
        "TopUpThreshold": 1,
        "TopUpType": 17,
        "WholeSaleSalesRepresentativeId": 1,
        "WholeSalesPartnerId": 1
      }
    },
    {
      "CategoryId": 1,
      "VoluntaryTopupAmount": 2.0,
      "OrderDetail": {
        "DonorAccountNumber": "sample string 1",
        "DonorContractTypePrepaid": true,
        "DonorOperatorCode": "sample string 2",
        "IccId": "sample string 3",
        "NpSubscriberId": "sample string 4",
        "NumberPorting": true,
        "NumberReservationCode": "sample string 6",
        "PhoneNumber": "sample string 7",
        "SimTypeId": 8,
        "TempNumberStartDate": "2025-04-28T00:58:52.698315+02:00",
        "TemporaryPhoneNumber": "sample string 9",
        "BankInformationId": 1,
        "CreatedBy": "sample string 10",
        "CustomerId": 11,
        "Date": "2025-04-28T00:58:52.698315+02:00",
        "InitialBalance": 1,
        "OrderGroupGuid": "a7d160f7-c91a-4511-a413-a9748adfaadf",
        "PackageProvisioningCode": 13,
        "PayerAddressId": 1,
        "PaymentInformationId": 1,
        "PricePlanProvisioningCode": 14,
        "ProductProvisioningCodes": [
          1,
          2
        ],
        "SalesCode": "sample string 15",
        "ShippingAddressId": 1,
        "SubscriptionTypeId": 16,
        "TopUpAmount": 1,
        "TopUpThreshold": 1,
        "TopUpType": 17,
        "WholeSaleSalesRepresentativeId": 1,
        "WholeSalesPartnerId": 1
      }
    }
  ],
  "PaymentId": 1,
  "OrderPaymentAccountSourceId": "sample string 2",
  "OrderPaymentDescription": "sample string 3",
  "NewBillingAddress": {
    "Address": {
      "ApartmentNumber": "sample string 1",
      "Attention": "sample string 2",
      "City": "sample string 3",
      "Co": "sample string 4",
      "ContactEmail": "sample string 5",
      "ContactName": "sample string 6",
      "ContactPhoneNumber": "sample string 7",
      "Country": "sample string 8",
      "Email": "sample string 9",
      "FaxNumber": "sample string 10",
      "Floor": "sample string 11",
      "HouseNumber": "sample string 12",
      "Letter": "sample string 13",
      "PhoneNumber": "sample string 14",
      "PlaceName": "sample string 15",
      "PostBox": "sample string 16",
      "Side": "sample string 17",
      "Street": "sample string 18",
      "ZipCode": "sample string 19"
    },
    "CompanyName": "sample string 1",
    "CustomerType": 2,
    "Firstname": "sample string 3",
    "Lastname": "sample string 4"
  },
  "NewShippingAddress": {
    "Address": {
      "ApartmentNumber": "sample string 1",
      "Attention": "sample string 2",
      "City": "sample string 3",
      "Co": "sample string 4",
      "ContactEmail": "sample string 5",
      "ContactName": "sample string 6",
      "ContactPhoneNumber": "sample string 7",
      "Country": "sample string 8",
      "Email": "sample string 9",
      "FaxNumber": "sample string 10",
      "Floor": "sample string 11",
      "HouseNumber": "sample string 12",
      "Letter": "sample string 13",
      "PhoneNumber": "sample string 14",
      "PlaceName": "sample string 15",
      "PostBox": "sample string 16",
      "Side": "sample string 17",
      "Street": "sample string 18",
      "ZipCode": "sample string 19"
    },
    "CompanyName": "sample string 1",
    "CustomerType": 2,
    "Firstname": "sample string 3",
    "Lastname": "sample string 4"
  }
}

text/html

Sample:

{"OrderDetails":[{"CategoryId":1,"VoluntaryTopupAmount":2.0,"OrderDetail":{"DonorAccountNumber":"sample string 1","DonorContractTypePrepaid":true,"DonorOperatorCode":"sample string 2","IccId":"sample string 3","NpSubscriberId":"sample string 4","NumberPorting":true,"NumberReservationCode":"sample string 6","PhoneNumber":"sample string 7","SimTypeId":8,"TempNumberStartDate":"2025-04-28T00:58:52.698315+02:00","TemporaryPhoneNumber":"sample string 9","BankInformationId":1,"CreatedBy":"sample string 10","CustomerId":11,"Date":"2025-04-28T00:58:52.698315+02:00","InitialBalance":1,"OrderGroupGuid":"a7d160f7-c91a-4511-a413-a9748adfaadf","PackageProvisioningCode":13,"PayerAddressId":1,"PaymentInformationId":1,"PricePlanProvisioningCode":14,"ProductProvisioningCodes":[1,2],"SalesCode":"sample string 15","ShippingAddressId":1,"SubscriptionTypeId":16,"TopUpAmount":1,"TopUpThreshold":1,"TopUpType":17,"WholeSaleSalesRepresentativeId":1,"WholeSalesPartnerId":1}},{"CategoryId":1,"VoluntaryTopupAmount":2.0,"OrderDetail":{"DonorAccountNumber":"sample string 1","DonorContractTypePrepaid":true,"DonorOperatorCode":"sample string 2","IccId":"sample string 3","NpSubscriberId":"sample string 4","NumberPorting":true,"NumberReservationCode":"sample string 6","PhoneNumber":"sample string 7","SimTypeId":8,"TempNumberStartDate":"2025-04-28T00:58:52.698315+02:00","TemporaryPhoneNumber":"sample string 9","BankInformationId":1,"CreatedBy":"sample string 10","CustomerId":11,"Date":"2025-04-28T00:58:52.698315+02:00","InitialBalance":1,"OrderGroupGuid":"a7d160f7-c91a-4511-a413-a9748adfaadf","PackageProvisioningCode":13,"PayerAddressId":1,"PaymentInformationId":1,"PricePlanProvisioningCode":14,"ProductProvisioningCodes":[1,2],"SalesCode":"sample string 15","ShippingAddressId":1,"SubscriptionTypeId":16,"TopUpAmount":1,"TopUpThreshold":1,"TopUpType":17,"WholeSaleSalesRepresentativeId":1,"WholeSalesPartnerId":1}}],"PaymentId":1,"OrderPaymentAccountSourceId":"sample string 2","OrderPaymentDescription":"sample string 3","NewBillingAddress":{"Address":{"ApartmentNumber":"sample string 1","Attention":"sample string 2","City":"sample string 3","Co":"sample string 4","ContactEmail":"sample string 5","ContactName":"sample string 6","ContactPhoneNumber":"sample string 7","Country":"sample string 8","Email":"sample string 9","FaxNumber":"sample string 10","Floor":"sample string 11","HouseNumber":"sample string 12","Letter":"sample string 13","PhoneNumber":"sample string 14","PlaceName":"sample string 15","PostBox":"sample string 16","Side":"sample string 17","Street":"sample string 18","ZipCode":"sample string 19"},"CompanyName":"sample string 1","CustomerType":2,"Firstname":"sample string 3","Lastname":"sample string 4"},"NewShippingAddress":{"Address":{"ApartmentNumber":"sample string 1","Attention":"sample string 2","City":"sample string 3","Co":"sample string 4","ContactEmail":"sample string 5","ContactName":"sample string 6","ContactPhoneNumber":"sample string 7","Country":"sample string 8","Email":"sample string 9","FaxNumber":"sample string 10","Floor":"sample string 11","HouseNumber":"sample string 12","Letter":"sample string 13","PhoneNumber":"sample string 14","PlaceName":"sample string 15","PostBox":"sample string 16","Side":"sample string 17","Street":"sample string 18","ZipCode":"sample string 19"},"CompanyName":"sample string 1","CustomerType":2,"Firstname":"sample string 3","Lastname":"sample string 4"}}

application/xml, text/xml

Sample:

<OrdersController.OrderCreationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LimitlessMobile.WebAPI.Controllers">
  <NewBillingAddress>
    <Address xmlns="">
      <ApartmentNumber>sample string 1</ApartmentNumber>
      <Attention>sample string 2</Attention>
      <City>sample string 3</City>
      <Co>sample string 4</Co>
      <ContactEmail>sample string 5</ContactEmail>
      <ContactName>sample string 6</ContactName>
      <ContactPhoneNumber>sample string 7</ContactPhoneNumber>
      <Country>sample string 8</Country>
      <Email>sample string 9</Email>
      <FaxNumber>sample string 10</FaxNumber>
      <Floor>sample string 11</Floor>
      <HouseNumber>sample string 12</HouseNumber>
      <Letter>sample string 13</Letter>
      <PhoneNumber>sample string 14</PhoneNumber>
      <PlaceName>sample string 15</PlaceName>
      <PostBox>sample string 16</PostBox>
      <Side>sample string 17</Side>
      <Street>sample string 18</Street>
      <ZipCode>sample string 19</ZipCode>
    </Address>
    <CompanyName xmlns="">sample string 1</CompanyName>
    <CustomerType xmlns="">2</CustomerType>
    <Firstname xmlns="">sample string 3</Firstname>
    <Lastname xmlns="">sample string 4</Lastname>
  </NewBillingAddress>
  <NewShippingAddress>
    <Address xmlns="">
      <ApartmentNumber>sample string 1</ApartmentNumber>
      <Attention>sample string 2</Attention>
      <City>sample string 3</City>
      <Co>sample string 4</Co>
      <ContactEmail>sample string 5</ContactEmail>
      <ContactName>sample string 6</ContactName>
      <ContactPhoneNumber>sample string 7</ContactPhoneNumber>
      <Country>sample string 8</Country>
      <Email>sample string 9</Email>
      <FaxNumber>sample string 10</FaxNumber>
      <Floor>sample string 11</Floor>
      <HouseNumber>sample string 12</HouseNumber>
      <Letter>sample string 13</Letter>
      <PhoneNumber>sample string 14</PhoneNumber>
      <PlaceName>sample string 15</PlaceName>
      <PostBox>sample string 16</PostBox>
      <Side>sample string 17</Side>
      <Street>sample string 18</Street>
      <ZipCode>sample string 19</ZipCode>
    </Address>
    <CompanyName xmlns="">sample string 1</CompanyName>
    <CustomerType xmlns="">2</CustomerType>
    <Firstname xmlns="">sample string 3</Firstname>
    <Lastname xmlns="">sample string 4</Lastname>
  </NewShippingAddress>
  <OrderDetails>
    <OrdersController.OrderItem>
      <CategoryId>1</CategoryId>
      <OrderDetail>
        <BankInformationId xmlns="">1</BankInformationId>
        <CreatedBy xmlns="">sample string 10</CreatedBy>
        <CustomerId xmlns="">11</CustomerId>
        <Date xmlns="">2025-04-28T00:58:52.698315+02:00</Date>
        <InitialBalance xmlns="">1</InitialBalance>
        <OrderGroupGuid xmlns="">a7d160f7-c91a-4511-a413-a9748adfaadf</OrderGroupGuid>
        <PackageProvisioningCode xmlns="">13</PackageProvisioningCode>
        <PayerAddressId xmlns="">1</PayerAddressId>
        <PaymentInformationId xmlns="">1</PaymentInformationId>
        <PricePlanProvisioningCode xmlns="">14</PricePlanProvisioningCode>
        <ProductProvisioningCodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </ProductProvisioningCodes>
        <SalesCode xmlns="">sample string 15</SalesCode>
        <ShippingAddressId xmlns="">1</ShippingAddressId>
        <SubscriptionTypeId xmlns="">16</SubscriptionTypeId>
        <TopUpAmount xmlns="">1</TopUpAmount>
        <TopUpThreshold xmlns="">1</TopUpThreshold>
        <TopUpType xmlns="">17</TopUpType>
        <WholeSaleSalesRepresentativeId xmlns="">1</WholeSaleSalesRepresentativeId>
        <WholeSalesPartnerId xmlns="">1</WholeSalesPartnerId>
        <DonorAccountNumber xmlns="">sample string 1</DonorAccountNumber>
        <DonorContractTypePrepaid xmlns="">true</DonorContractTypePrepaid>
        <DonorOperatorCode xmlns="">sample string 2</DonorOperatorCode>
        <IccId xmlns="">sample string 3</IccId>
        <NpSubscriberId xmlns="">sample string 4</NpSubscriberId>
        <NumberPorting xmlns="">true</NumberPorting>
        <NumberReservationCode xmlns="">sample string 6</NumberReservationCode>
        <PhoneNumber xmlns="">sample string 7</PhoneNumber>
        <SimTypeId xmlns="">8</SimTypeId>
        <TempNumberStartDate xmlns="">2025-04-28T00:58:52.698315+02:00</TempNumberStartDate>
        <TemporaryPhoneNumber xmlns="">sample string 9</TemporaryPhoneNumber>
      </OrderDetail>
      <VoluntaryTopupAmount>2</VoluntaryTopupAmount>
    </OrdersController.OrderItem>
    <OrdersController.OrderItem>
      <CategoryId>1</CategoryId>
      <OrderDetail>
        <BankInformationId xmlns="">1</BankInformationId>
        <CreatedBy xmlns="">sample string 10</CreatedBy>
        <CustomerId xmlns="">11</CustomerId>
        <Date xmlns="">2025-04-28T00:58:52.698315+02:00</Date>
        <InitialBalance xmlns="">1</InitialBalance>
        <OrderGroupGuid xmlns="">a7d160f7-c91a-4511-a413-a9748adfaadf</OrderGroupGuid>
        <PackageProvisioningCode xmlns="">13</PackageProvisioningCode>
        <PayerAddressId xmlns="">1</PayerAddressId>
        <PaymentInformationId xmlns="">1</PaymentInformationId>
        <PricePlanProvisioningCode xmlns="">14</PricePlanProvisioningCode>
        <ProductProvisioningCodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </ProductProvisioningCodes>
        <SalesCode xmlns="">sample string 15</SalesCode>
        <ShippingAddressId xmlns="">1</ShippingAddressId>
        <SubscriptionTypeId xmlns="">16</SubscriptionTypeId>
        <TopUpAmount xmlns="">1</TopUpAmount>
        <TopUpThreshold xmlns="">1</TopUpThreshold>
        <TopUpType xmlns="">17</TopUpType>
        <WholeSaleSalesRepresentativeId xmlns="">1</WholeSaleSalesRepresentativeId>
        <WholeSalesPartnerId xmlns="">1</WholeSalesPartnerId>
        <DonorAccountNumber xmlns="">sample string 1</DonorAccountNumber>
        <DonorContractTypePrepaid xmlns="">true</DonorContractTypePrepaid>
        <DonorOperatorCode xmlns="">sample string 2</DonorOperatorCode>
        <IccId xmlns="">sample string 3</IccId>
        <NpSubscriberId xmlns="">sample string 4</NpSubscriberId>
        <NumberPorting xmlns="">true</NumberPorting>
        <NumberReservationCode xmlns="">sample string 6</NumberReservationCode>
        <PhoneNumber xmlns="">sample string 7</PhoneNumber>
        <SimTypeId xmlns="">8</SimTypeId>
        <TempNumberStartDate xmlns="">2025-04-28T00:58:52.698315+02:00</TempNumberStartDate>
        <TemporaryPhoneNumber xmlns="">sample string 9</TemporaryPhoneNumber>
      </OrderDetail>
      <VoluntaryTopupAmount>2</VoluntaryTopupAmount>
    </OrdersController.OrderItem>
  </OrderDetails>
  <OrderPaymentAccountSourceId>sample string 2</OrderPaymentAccountSourceId>
  <OrderPaymentDescription>sample string 3</OrderPaymentDescription>
  <PaymentId>1</PaymentId>
</OrdersController.OrderCreationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The created order.

Collection of OrderDetailResult

Name	Type	Additional information
Success	boolean	None.
ErrorMessage	string	None.
Order	Order	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Success": true,
    "ErrorMessage": "sample string 2",
    "Order": {
      "CategoryId": 1,
      "CreatedDate": "2025-04-28T00:58:52.729561+02:00",
      "Date": "2025-04-28T00:58:52.729561+02:00",
      "Id": 4,
      "OrderTypeId": 5,
      "PhoneNumber": "sample string 6",
      "SalesCode": "sample string 7",
      "StatusId": 8,
      "SubscriptionId": 1,
      "WholeSalesPartnerId": 9
    }
  },
  {
    "Success": true,
    "ErrorMessage": "sample string 2",
    "Order": {
      "CategoryId": 1,
      "CreatedDate": "2025-04-28T00:58:52.729561+02:00",
      "Date": "2025-04-28T00:58:52.729561+02:00",
      "Id": 4,
      "OrderTypeId": 5,
      "PhoneNumber": "sample string 6",
      "SalesCode": "sample string 7",
      "StatusId": 8,
      "SubscriptionId": 1,
      "WholeSalesPartnerId": 9
    }
  }
]

text/html

Sample:

[{"Success":true,"ErrorMessage":"sample string 2","Order":{"CategoryId":1,"CreatedDate":"2025-04-28T00:58:52.729561+02:00","Date":"2025-04-28T00:58:52.729561+02:00","Id":4,"OrderTypeId":5,"PhoneNumber":"sample string 6","SalesCode":"sample string 7","StatusId":8,"SubscriptionId":1,"WholeSalesPartnerId":9}},{"Success":true,"ErrorMessage":"sample string 2","Order":{"CategoryId":1,"CreatedDate":"2025-04-28T00:58:52.729561+02:00","Date":"2025-04-28T00:58:52.729561+02:00","Id":4,"OrderTypeId":5,"PhoneNumber":"sample string 6","SalesCode":"sample string 7","StatusId":8,"SubscriptionId":1,"WholeSalesPartnerId":9}}]

application/xml, text/xml

Sample:

<ArrayOfOrdersController.OrderDetailResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LimitlessMobile.WebAPI.Controllers">
  <OrdersController.OrderDetailResult>
    <ErrorMessage>sample string 2</ErrorMessage>
    <Order>
      <CategoryId xmlns="">1</CategoryId>
      <CreatedDate xmlns="">2025-04-28T00:58:52.729561+02:00</CreatedDate>
      <Date xmlns="">2025-04-28T00:58:52.729561+02:00</Date>
      <Id xmlns="">4</Id>
      <OrderTypeId xmlns="">5</OrderTypeId>
      <PhoneNumber xmlns="">sample string 6</PhoneNumber>
      <SalesCode xmlns="">sample string 7</SalesCode>
      <StatusId xmlns="">8</StatusId>
      <SubscriptionId xmlns="">1</SubscriptionId>
      <WholeSalesPartnerId xmlns="">9</WholeSalesPartnerId>
    </Order>
    <Success>true</Success>
  </OrdersController.OrderDetailResult>
  <OrdersController.OrderDetailResult>
    <ErrorMessage>sample string 2</ErrorMessage>
    <Order>
      <CategoryId xmlns="">1</CategoryId>
      <CreatedDate xmlns="">2025-04-28T00:58:52.729561+02:00</CreatedDate>
      <Date xmlns="">2025-04-28T00:58:52.729561+02:00</Date>
      <Id xmlns="">4</Id>
      <OrderTypeId xmlns="">5</OrderTypeId>
      <PhoneNumber xmlns="">sample string 6</PhoneNumber>
      <SalesCode xmlns="">sample string 7</SalesCode>
      <StatusId xmlns="">8</StatusId>
      <SubscriptionId xmlns="">1</SubscriptionId>
      <WholeSalesPartnerId xmlns="">9</WholeSalesPartnerId>
    </Order>
    <Success>true</Success>
  </OrdersController.OrderDetailResult>
</ArrayOfOrdersController.OrderDetailResult>