api/v1/orders/cpe

Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/orders/cpe?testMode={testMode}

Summary

Create a CPE order

Request Information

URI Parameters

NameDescriptionTypeAdditional information
testMode

boolean

Default value is False

Body Parameters

This model contains all of the information required to create a router

CreateCPEOrderModel
NameDescriptionTypeAdditional information
SKU

string

None.

TariffId

globally unique identifier

None.

CustomerId

globally unique identifier

None.

DeliveryAddress

DeliverAddress

None.

DeliveryNotes

string

None.

RequestedDeliveryDate

date

None.

SIMDefaultEmail

string

None.

SIMTags

string

None.

Reason

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SKU": "sample string 1",
  "TariffId": "9be9575b-a70b-44ca-83db-fb6a13a89700",
  "CustomerId": "c69e05cd-88da-4336-a601-0eafb1c91108",
  "DeliveryAddress": {
    "Title": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "ContactPhoneNumber": "sample string 4",
    "ContactEmail": "sample string 5",
    "CompanyName": "sample string 6",
    "PremisesName": "sample string 7",
    "PremisesNumber": "sample string 8",
    "PremisesStreet": "sample string 9",
    "AddressLine2": "sample string 10",
    "AddressLine3": "sample string 11",
    "TownCity": "sample string 12",
    "Country": "sample string 13",
    "PostCode": "sample string 14"
  },
  "DeliveryNotes": "sample string 3",
  "RequestedDeliveryDate": "2022-05-21T06:09:42.9535609+00:00",
  "SIMDefaultEmail": "sample string 5",
  "SIMTags": "sample string 6",
  "Reason": "sample string 7"
}

application/xml, text/xml

Sample:
<CreateCPEOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders">
  <Reason>sample string 7</Reason>
  <CustomerId>c69e05cd-88da-4336-a601-0eafb1c91108</CustomerId>
  <DeliveryAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/JolaSimPortal.Shared.Models.Orders.OrderDataModels">
    <d2p1:AddressLine2>sample string 10</d2p1:AddressLine2>
    <d2p1:AddressLine3>sample string 11</d2p1:AddressLine3>
    <d2p1:CompanyName>sample string 6</d2p1:CompanyName>
    <d2p1:ContactEmail>sample string 5</d2p1:ContactEmail>
    <d2p1:ContactPhoneNumber>sample string 4</d2p1:ContactPhoneNumber>
    <d2p1:Country>sample string 13</d2p1:Country>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:LastName>sample string 3</d2p1:LastName>
    <d2p1:PostCode>sample string 14</d2p1:PostCode>
    <d2p1:PremisesName>sample string 7</d2p1:PremisesName>
    <d2p1:PremisesNumber>sample string 8</d2p1:PremisesNumber>
    <d2p1:PremisesStreet>sample string 9</d2p1:PremisesStreet>
    <d2p1:Title>sample string 1</d2p1:Title>
    <d2p1:TownCity>sample string 12</d2p1:TownCity>
  </DeliveryAddress>
  <DeliveryNotes>sample string 3</DeliveryNotes>
  <RequestedDeliveryDate>2022-05-21T06:09:42.9535609+00:00</RequestedDeliveryDate>
  <SIMDefaultEmail>sample string 5</SIMDefaultEmail>
  <SIMTags>sample string 6</SIMTags>
  <SKU>sample string 1</SKU>
  <TariffId>9be9575b-a70b-44ca-83db-fb6a13a89700</TariffId>
</CreateCPEOrderModel>

application/x-www-form-urlencoded

Sample:
SKU=samplestring&TariffId=value&CustomerId=a1234567-gu1d-3x4m-pl31-e1f2g12345678&DeliveryAddress=value&DeliveryNotes=samplestring&RequestedDeliveryDate=5/17/2022 4:33:40 PM&SIMDefaultEmail=samplestring&SIMTags=samplestring&Reason=samplestring

Response Information

Resource Description

OrderResponseModel
NameDescriptionTypeAdditional information
OrderId

globally unique identifier

None.

Created

date

None.

State

OrderState

None.

Response Formats

application/json, text/json

Sample:
{
  "OrderId": "da62f79f-da6e-40b4-81d3-6bcac5d77999",
  "Created": "2022-05-21T06:09:43.6410668+00:00",
  "State": 0
}

application/xml, text/xml

Sample:
<OrderResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders" />