ECG Orders API (Development) v1.1.4 (1.1.4)

Download OpenAPI specification:Download

Electronic Caregiver Development Team: support@ecg-hq.com URL: https://www.electroniccaregiver.com/ License: Electronic Caregiver

ECG Orders API allows you to define Contracts, create and manage Orders.

Authentication

Bearer

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Security Scheme Type API Key
Header parameter name: Authorization

BulkOrders

Validates the incoming bulk order data

Request
Security:
Bearer
Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
required
Array of objects (OrderCriteriaModel)
Responses
200

Success

400

Bad Request

post/bulk-orders/validate
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "outcomes": [
    ]
}

Accepts bulk order information

Request
Security:
Bearer
Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
required
Array of objects (OrderCriteriaModel)
Responses
200

Success

400

Bad Request

post/bulk-orders
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

ContractLineItems

Gets a List of the Contract's Line Items

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for Listing contract line items

contractId
required
string

ID of the contract for Listing contract line items

Responses
200

Success

400

Bad Request

401

Unauthorized

get/organizations/{organizationId}/contracts/{contractId}/line-items
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/line-items' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "items": [
    ]
}

Creates a Line Item.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for create contract line item

contractId
required
string

ID of the contract for create contract line item

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload for create a contract line item

optional
required
boolean
lineItemType
required
string (ContractItemTypeEnumModel)
Enum: "PrimaryProduct" "DeviceOrService" "ProductType" "GroupedProduct"
object (PrimaryProductLineItemAddModel)
object (ProductTypeSelectionLineItemAddModel)
object (DeviceOrServiceLineItemAddModel)
object (GroupedProductsLineItemAddModel)
Responses
201

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts/{contractId}/line-items
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "optional": true,
  • "lineItemType": "PrimaryProduct",
  • "primaryProductLineItem": {
    },
  • "productTypeLineItem": {
    },
  • "deviceOrServiceLineItem": {
    },
  • "groupedProductsLineItem": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "optional": true,
  • "lineItemType": "PrimaryProduct",
  • "primaryProductLineItem": {
    },
  • "productTypeLineItem": {
    },
  • "deviceOrServiceLineItem": {
    },
  • "groupedProductsLineItem": {
    },
  • "audit": {
    },
  • "activation": {
    },
  • "archive": {
    }
}

Gets the Contract Line Item.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization to get contract line item

contractId
required
string

ID of the contract to get contract line item

lineItemId
required
string

ID of the contract line item

Responses
200

Success

400

Bad Request

401

Unauthorized

get/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "optional": true,
  • "lineItemType": "PrimaryProduct",
  • "primaryProductLineItem": {
    },
  • "productTypeLineItem": {
    },
  • "deviceOrServiceLineItem": {
    },
  • "groupedProductsLineItem": {
    },
  • "audit": {
    },
  • "activation": {
    },
  • "archive": {
    }
}

Delete contract line item.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization to delete

contractId
required
string

ID of the contract to delete

lineItemId
required
string

ID of the contract line item to delete

Responses
200

Success

400

Bad Request

401

Unauthorized

delete/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}
Request samples
curl -i -X DELETE \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Archive contract line item.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for archives the contract line item

contractId
required
string

ID of the contract for archives the contract line item

lineItemId
required
string

ID of the the contract line item for archive

Responses
200

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}/archive
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}/archive' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Restore contract line item.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for restores the contract line item

contractId
required
string

ID of the contract for restores the contract line item

lineItemId
required
string

ID of the the contract line item for restore

Responses
200

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}/restore
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}/restore' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Updates the Primary Product Contract Line Item.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for updates

contractId
required
string

ID of the contract for updates

lineItemId
required
string

ID of contract line item for updates

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

JSON patch object

Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}/primary-product
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "optional": true,
  • "lineItemType": "PrimaryProduct",
  • "primaryProductLineItem": {
    },
  • "productTypeLineItem": {
    },
  • "deviceOrServiceLineItem": {
    },
  • "groupedProductsLineItem": {
    },
  • "audit": {
    },
  • "activation": {
    },
  • "archive": {
    }
}

Updates the Device/Service Line Item.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for updates

contractId
required
string

ID of the contract for updates

lineItemId
required
string

ID of contract line item for updates

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

JSON patch object

Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}/device-service
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "optional": true,
  • "lineItemType": "PrimaryProduct",
  • "primaryProductLineItem": {
    },
  • "productTypeLineItem": {
    },
  • "deviceOrServiceLineItem": {
    },
  • "groupedProductsLineItem": {
    },
  • "audit": {
    },
  • "activation": {
    },
  • "archive": {
    }
}

Updates a Product Type Selection Line Item.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for updates

contractId
required
string

ID of the contract for updates

lineItemId
required
string

ID of contract line item for updates

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

JSON patch object

Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}/product-type-selection
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "optional": true,
  • "lineItemType": "PrimaryProduct",
  • "primaryProductLineItem": {
    },
  • "productTypeLineItem": {
    },
  • "deviceOrServiceLineItem": {
    },
  • "groupedProductsLineItem": {
    },
  • "audit": {
    },
  • "activation": {
    },
  • "archive": {
    }
}

Updates the Grouped Product Line Item.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for updates

contractId
required
string

ID of the contract for updates

lineItemId
required
string

ID of contract line item for updates

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

JSON patch object

Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/organizations/{organizationId}/contracts/{contractId}/line-items/{lineItemId}/grouped-products
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "optional": true,
  • "lineItemType": "PrimaryProduct",
  • "primaryProductLineItem": {
    },
  • "productTypeLineItem": {
    },
  • "deviceOrServiceLineItem": {
    },
  • "groupedProductsLineItem": {
    },
  • "audit": {
    },
  • "activation": {
    },
  • "archive": {
    }
}

Contracts

Get paginated list of Contracts (With filters)

Request
Security:
Bearer
query Parameters
organizationIds
Array of strings

IDs of the organization for Listing contracts

searchTerm
string
Default: ""

Search with Title, Description and Cunrrency Code

skip
integer <int32>
Default: 0

Number of Pages to skip, Default value : 0

take
integer <int32>
Default: 25

Number of Records per page, Default value : 25

orderBy
string
Default: "desc"

Possible values 'asc' and 'desc'

status
string (ContractStatusEnum)

Search by contract status

Enum: "Draft" "Published"
Responses
200

Success

400

Bad Request

401

Unauthorized

get/contracts
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/contracts?organizationIds=string&searchTerm=&skip=0&take=25&orderBy=desc&status=Draft' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "currentPageNumber": 0,
  • "totalRecords": 0,
  • "recordsPerPage": 0,
  • "totalPages": 0,
  • "items": [
    ]
}

Creates a Contract.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for create a contract

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

currencyCode
required
string
required
object (DescriptionInfoModel)
required
object (DateRangeModel)
Responses
201

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "currencyCode": "string",
  • "descriptionInfo": {
    },
  • "effectiveDates": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "organizationId": "string",
  • "organization": {
    },
  • "descriptionInfo": {
    },
  • "currencyCode": "string",
  • "effectiveDates": {
    },
  • "status": "Draft",
  • "lineItems": [
    ],
  • "shippingPrices": [
    ],
  • "audit": {
    },
  • "archive": {
    }
}

Lists the Contracts for a given Organization

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for Listing cotracts

query Parameters
skip
integer <int32>
Default: 0

Number of Pages to skip, Default value : 0

take
integer <int32>
Default: 25

Number of Records per page, Default value : 25

status
string (ContractStatusEnum)

Search by contract status

Enum: "Draft" "Published"
parentContracts
boolean
Default: false

Include parent organization contracts

Responses
200

Success

400

Bad Request

401

Unauthorized

get/organizations/{organizationId}/contracts
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts?skip=0&take=25&status=Draft&parentContracts=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "currentPageNumber": 0,
  • "totalRecords": 0,
  • "recordsPerPage": 0,
  • "totalPages": 0,
  • "items": [
    ]
}

Gets the Contract By ID.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization to get contract

contractId
required
string

ID of the contract to get

query Parameters
include
string
Default: ""

Possible value is line-items,shipping

Responses
200

Success

400

Bad Request

401

Unauthorized

get/organizations/{organizationId}/contracts/{contractId}
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}?include=' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "organizationId": "string",
  • "organization": {
    },
  • "descriptionInfo": {
    },
  • "currencyCode": "string",
  • "effectiveDates": {
    },
  • "status": "Draft",
  • "lineItems": [
    ],
  • "shippingPrices": [
    ],
  • "audit": {
    },
  • "archive": {
    }
}

Update the Contract details.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for update

contractId
required
string

ID of the contract for update

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

JSON Patch object

Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/organizations/{organizationId}/contracts/{contractId}
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "organizationId": "string",
  • "organization": {
    },
  • "descriptionInfo": {
    },
  • "currencyCode": "string",
  • "effectiveDates": {
    },
  • "status": "Draft",
  • "lineItems": [
    ],
  • "shippingPrices": [
    ],
  • "audit": {
    },
  • "archive": {
    }
}

Archives the Contract.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for archives the contract

contractId
required
string

ID of the contract for archive

Responses
200

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts/{contractId}/archive
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/archive' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Restores the Contract.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for restores the contract

contractId
required
string

ID of the contract for restore

Responses
200

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts/{contractId}/restore
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/restore' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Publish Contract

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization

contractId
required
string

ID of the contract

Responses
200

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts/{contractId}/publish
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/publish' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "organizationId": "string",
  • "organization": {
    },
  • "descriptionInfo": {
    },
  • "currencyCode": "string",
  • "effectiveDates": {
    },
  • "status": "Draft",
  • "lineItems": [
    ],
  • "shippingPrices": [
    ],
  • "audit": {
    },
  • "archive": {
    }
}

Draft Contract

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization

contractId
required
string

ID of the contract

Responses
200

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts/{contractId}/draft
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/draft' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "organizationId": "string",
  • "organization": {
    },
  • "descriptionInfo": {
    },
  • "currencyCode": "string",
  • "effectiveDates": {
    },
  • "status": "Draft",
  • "lineItems": [
    ],
  • "shippingPrices": [
    ],
  • "audit": {
    },
  • "archive": {
    }
}

ContractShippingOptions

Lists the Contract's Shipping Options.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for Listing contract's shipping option

contractId
required
string

ID of the contract for Listing contract's shipping option

Responses
200

Success

400

Bad Request

401

Unauthorized

get/organizations/{organizationId}/contracts/{contractId}/shipping-options
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/shipping-options' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "items": [
    ]
}

Adds a shipping option to a contract.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for add contract's shipping option

contractId
required
string

ID of the contract for add contract's shipping option

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

object (DescriptionInfoModel)
object (PriceModel)
Responses
201

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts/{contractId}/shipping-options
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "descriptionInfo": {
    },
  • "price": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "priceDescriptor": {
    },
  • "archive": {
    }
}

Gets the Shipping Options by Id.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization to get contract's shipping option

contractId
required
string

ID of the contract to get contract's shipping option

optionId
required
string

ID of the contract's shipping option

Responses
200

Success

400

Bad Request

401

Unauthorized

get/organizations/{organizationId}/contracts/{contractId}/shipping-options/{optionId}
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/shipping-options/{optionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "priceDescriptor": {
    },
  • "archive": {
    }
}

Delete shipping option.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization to delete

contractId
required
string

ID of the contract to delete

optionId
required
string

ID of the shipping option to delete

Responses
200

Success

400

Bad Request

401

Unauthorized

delete/organizations/{organizationId}/contracts/{contractId}/shipping-options/{optionId}
Request samples
curl -i -X DELETE \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/shipping-options/{optionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Patch shipping option.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for update shipping option

contractId
required
string

ID of the contract for update shipping option

optionId
required
string

ID of the shipping option

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

JSON patch object

Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/organizations/{organizationId}/contracts/{contractId}/shipping-options/{optionId}
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "priceDescriptor": {
    },
  • "archive": {
    }
}

Archives the shipping option.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for archives the shipping option

contractId
required
string

ID of the contract for archives the shipping option

optionId
required
string

ID of the shipping option

Responses
200

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts/{contractId}/shipping-options/{optionId}/archive
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/shipping-options/{optionId}/archive' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Restores the shipping option.

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization for restores the shipping option

contractId
required
string

ID of the contract for restores the shipping option

optionId
required
string

ID of the shipping option

Responses
200

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/contracts/{contractId}/shipping-options/{optionId}/restore
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/contracts/{contractId}/shipping-options/{optionId}/restore' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Health

Check health of the server.

Request
Security:
Bearer
Responses
200

Success

get/healthcheck
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/healthcheck \
  -H 'Authorization: YOUR_API_KEY_HERE'

Integrations

User login with rapid.

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

post/integrations/rapid/login
Request samples
curl -i -X POST \
  https://orders-dev.ecg-api.com/integrations/rapid/login \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Rapid user login logout.

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

post/integrations/rapid/logout
Request samples
curl -i -X POST \
  https://orders-dev.ecg-api.com/integrations/rapid/logout \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Get RRMS Action Plans

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

get/rrms/action-plans
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/rrms/action-plans \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "items": [
    ]
}

Get RRMS Action Plan by code

Request
Security:
Bearer
path Parameters
code
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

get/rrms/action-plans/{code}
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/rrms/action-plans/{code}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "code": "string",
  • "description": "string"
}

List all pending RRMS events

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

get/rrms/events
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/rrms/events \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "items": [
    ]
}

Process/Re-try all pending RRMS events

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

post/rrms/events
Request samples
curl -i -X POST \
  https://orders-dev.ecg-api.com/rrms/events \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Process/Re-try pending RRMS event

Request
Security:
Bearer
path Parameters
eventId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

post/rrms/events/{eventId}
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/rrms/events/{eventId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

OrderLineItems

Gets the order line-item's status listing.

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

get/line-items/status-listing
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/line-items/status-listing \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Add a line item to the order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to add the line item to

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

productId
string or null
variantProductId
string or null
associatedContractLineItemId
string or null
object (WarrantySelectionModel)
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/line-items
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "productId": "string",
  • "variantProductId": "string",
  • "associatedContractLineItemId": "string",
  • "warrantySelection": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Get all line items for order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

Responses
200

Success

400

Bad Request

401

Unauthorized

get/orders/{orderId}/line-items
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/orders/{orderId}/line-items' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Update a line item of the order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item to update

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

JSON Patch object

Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/orders/{orderId}/line-items/{lineItemId}
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Delete line item from the order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item to delete

Responses
200

Success

400

Bad Request

401

Unauthorized

delete/orders/{orderId}/line-items/{lineItemId}/delete
Request samples
curl -i -X DELETE \
  'https://orders-dev.ecg-api.com/orders/{orderId}/line-items/{lineItemId}/delete' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Orders

Gets the Order's status listing.

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

401

Unauthorized

get/orders/status-listing
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/orders/status-listing \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Get paginated list of orders (With filters)

Request
Security:
Bearer
query Parameters
skip
integer <int32>
Default: 0

Number of Pages to skip, Default value : 0

take
integer <int32>
Default: 25

Number of Records per page, Default value : 25

orderStatuses
Array of integers <int32>

Order statuses

productIds
Array of strings

Product IDs to filter by

organizationIds
Array of strings

Organization IDs to filter by

provisioningNeeded
boolean

Filter orders based on provisioning needed flag

searchTerm
string
Default: ""

Filter by Order Code, Subscriber's name, provisioning data

sortBy
string (SortBy)

Sort orders by createdAt or updatedAt

Enum: "CreatedAt" "UpdatedAt"
orderBy
string
Default: "desc"

Possible values 'asc' and 'desc'

fromDate
string <date-time>

The UTC Start date to filter orders by

toDate
string <date-time>

The UTC End date to filter orders by

include
string
Default: ""

Possible value is 'order-line-items'

Responses
200

Success

400

Bad Request

401

Unauthorized

get/orders
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/orders?skip=0&take=25&orderStatuses=0&productIds=string&organizationIds=string&provisioningNeeded=true&searchTerm=&sortBy=CreatedAt&orderBy=desc&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z&include=' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "currentPageNumber": 0,
  • "totalRecords": 0,
  • "recordsPerPage": 0,
  • "totalPages": 0,
  • "items": [
    ]
}

Create an order

Request
Security:
Bearer
Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

contractId
string or null
organizationId
string or null
subscriberId
required
string
orderCode
string or null
orderType
required
string (OrderTypeEnum)
Enum: "New" "Replacement"
object (AddShippingInformationModel)
object (AddServiceDetailsModel)
object (AddAcceptedWaiversModel)
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "orderType": "New",
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "acceptedWaiversInformation": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Get an order by Id

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to get

query Parameters
include
string
Default: ""

Possible value is 'order-line-items'

Responses
200

Success

400

Bad Request

401

Unauthorized

get/orders/{orderId}
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/orders/{orderId}?include=' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Update an order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to update

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

JSON Patch object

Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/orders/{orderId}
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Delete an order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order to delete

Responses
200

Success

400

Bad Request

401

Unauthorized

delete/orders/{orderId}/delete
Request samples
curl -i -X DELETE \
  'https://orders-dev.ecg-api.com/orders/{orderId}/delete' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Add shipping information for order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to add the shipping information too

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

sameAsPrimaryAddress
required
boolean
sameAsOrganizationAddress
required
boolean
required
object (NameInformationServiceModel)
required
object (AddressInformationModel)
shippingNotes
string or null
shippingMethodId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/shipping-information
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "sameAsPrimaryAddress": true,
  • "sameAsOrganizationAddress": true,
  • "shippingContactName": {
    },
  • "shippingAddress": {
    },
  • "shippingNotes": "string",
  • "shippingMethodId": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Update shipping information of order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to update the shipping information of

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

JSON Patch object

Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/orders/{orderId}/shipping-information
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Adds service details to order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to add service details too

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

expectedServiceStartDate
string or null <date-time>
serviceStartDisclaimerAccepted
boolean
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/service-details
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "expectedServiceStartDate": "2019-08-24T14:15:22Z",
  • "serviceStartDisclaimerAccepted": true
}
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Update service details.

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to update service details of

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

JSON Patch object

Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/orders/{orderId}/service-details
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Add accepted waivers to order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to add accepted waivers too

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

acceptedWaiverIds
Array of strings or null
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/accepted-waivers
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "acceptedWaiverIds": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Get order activities

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order to get activities of

Responses
200

Success

400

Bad Request

401

Unauthorized

get/orders/{orderId}/activity
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/orders/{orderId}/activity' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

In-Process order

Request
Security:
Bearer
path Parameters
orderId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/in-process
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/in-process' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Confirm order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order to confirm

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

priceBreakdownForMonthlyAndOneTimeFees
boolean
makeChangesUntilShipmentIsReady
boolean
authorizeECGToContactWithWelcomePackageDelivery
boolean
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/confirm
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "priceBreakdownForMonthlyAndOneTimeFees": true,
  • "makeChangesUntilShipmentIsReady": true,
  • "authorizeECGToContactWithWelcomePackageDelivery": true
}
Response samples
application/json
{
  • "value": true
}

Send/Re-send order confirmation email

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/email-confirmation
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/email-confirmation' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Cancel order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order to cancel

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

reason
required
integer <int32>
description
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/cancel
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "reason": 0,
  • "description": "string"
}
Response samples
application/json
{
  • "value": true
}

Reactivate order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order to re-activate

Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/reactivate
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/reactivate' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Mark Delivery Address as verified

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order

Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/delivery-address-verified
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/delivery-address-verified' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Create/Update shipment details

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

shipmentId
required
string
rateId
string or null
object (AddShipmentTrackingModel)
shippingCost
string or null
shipDate
string <date-time>
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/shipment-details
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "shipmentId": "string",
  • "rateId": "string",
  • "trackingDetails": {
    },
  • "shippingCost": "string",
  • "shipDate": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "shipmentDetails": {
    }
}

Get Shipment details

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order

Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

get/orders/{orderId}/shipment-details
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/orders/{orderId}/shipment-details' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "shipmentDetails": {
    }
}

Set Order status to Shipped

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order

Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

post/orders/{orderId}/shipped
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/shipped' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Cancel the shipment

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order

Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

post/orders/{orderId}/cancel-shipment
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/cancel-shipment' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Change Weight Information

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

weight
required
number <double>
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/delivery-weight-info
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "weight": 0
}
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Change Crate Dimensions Information

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of order

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

crateId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/delivery-crate
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "crateId": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "contractId": "string",
  • "organizationId": "string",
  • "subscriberId": "string",
  • "orderCode": "string",
  • "provisioningNeeded": true,
  • "orderType": "New",
  • "confirmationCode": "string",
  • "orderStatus": {
    },
  • "shippingInformation": {
    },
  • "serviceDetails": {
    },
  • "totals": {
    },
  • "acceptedWaiverInformation": {
    },
  • "audit": {
    },
  • "orderLineItems": [
    ]
}

Gets the Cancellation Reason listing.

Request
Security:
Bearer
Responses
200

Success

401

Unauthorized

get/orders/cancel-reason-listing
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/orders/cancel-reason-listing \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Get all shipment crates

Request
Security:
Bearer
Responses
200

Success

401

Unauthorized

get/orders/shipment-crates
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/orders/shipment-crates \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Packages

Add packages.

Request
Security:
Bearer
Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
title
required
string
description
required
string
category
required
string (ProductCategoryEnum)
Enum: "Standard" "Premium" "Core"
productType
required
string (ProductTypeEnum)
Enum: "Device" "Service" "Accessory" "Core"
Array of objects or null (AddPackageItemModel)
Responses
200

Success

400

Bad Request

401

Unauthorized

post/packages
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "title": "string",
  • "description": "string",
  • "category": "Standard",
  • "productType": "Device",
  • "items": [
    ]
}
Response samples
text/plain
text/plain
application/json
text/json
No sample

Get list of packages.

Request
Security:
Bearer
query Parameters
skip
integer <int32>
Default: 0

Number of Pages to skip, Default value : 0

take
integer <int32>
Default: 25

Number of Records per page, Default value : 25

Responses
200

Success

400

Bad Request

401

Unauthorized

get/packages
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/packages?skip=0&take=25' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Add package items.

Request
Security:
Bearer
path Parameters
packageId
required
string
Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
Array
productId
string or null
quantity
integer <int32>
Responses
200

Success

400

Bad Request

401

Unauthorized

post/packages/{packageId}/package-items
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
text/plain
text/plain
application/json
text/json
No sample

Active package item.

Request
Security:
Bearer
path Parameters
packageId
required
string
packageItemId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

post/packages/{packageId}/package-items/{packageItemId}/active
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/packages/{packageId}/package-items/{packageItemId}/active' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Deactive package item.

Request
Security:
Bearer
path Parameters
packageId
required
string
packageItemId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

post/packages/{packageId}/package-items/{packageItemId}/deactive
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/packages/{packageId}/package-items/{packageItemId}/deactive' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Delete package.

Request
Security:
Bearer
path Parameters
packageId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

delete/packages/{packageId}
Request samples
curl -i -X DELETE \
  'https://orders-dev.ecg-api.com/packages/{packageId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Update package details.

Request
Security:
Bearer
path Parameters
packageId
required
string
Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/packages/{packageId}
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
text/plain
text/plain
application/json
text/json
No sample

Get package by Id.

Request
Security:
Bearer
path Parameters
packageId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

get/packages/{packageId}
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/packages/{packageId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Delete package item.

Request
Security:
Bearer
path Parameters
packageId
required
string
packageItemId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

delete/packages/{packageId}/package-items/{packageItemId}
Request samples
curl -i -X DELETE \
  'https://orders-dev.ecg-api.com/packages/{packageId}/package-items/{packageItemId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Update package item details.

Request
Security:
Bearer
path Parameters
packageId
required
string
packageItemId
required
string
Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
Array
value
any or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

patch/packages/{packageId}/package-items/{packageItemId}
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]
Response samples
text/plain
text/plain
application/json
text/json
No sample

Get package item by id.

Request
Security:
Bearer
path Parameters
packageId
required
string
packageItemId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

get/packages/{packageId}/package-items/{packageItemId}
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/packages/{packageId}/package-items/{packageItemId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Products

Syncing shopify products in DB.

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

post/sync-shopify-products
Request samples
curl -i -X POST \
  https://orders-dev.ecg-api.com/sync-shopify-products \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Add shopify product by shopifyProductId.

Request
Security:
Bearer
path Parameters
shopifyProductId
required
integer <int64>
Responses
200

Success

400

Bad Request

401

Unauthorized

post/shopify/{shopifyProductId}
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/shopify/{shopifyProductId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Get products.

Request
Security:
Bearer
query Parameters
searchTerm
string
Default: ""
title
string
Default: ""
description
string
Default: ""
category
string (ProductCategoryEnum)
Enum: "Standard" "Premium" "Core"
productType
string (ProductTypeEnum)
Enum: "Device" "Service" "Accessory" "Core"
tags
string
Default: ""
status
string (ProductStatusEnum)
Enum: "All" "Active" "Inactive"
mode
string (ProductModeEnum)
Enum: "All" "Parent" "Variant"
skip
integer <int32>
Default: 0

Number of Pages to skip, Default value : 0

take
integer <int32>
Default: 25

Number of Records per page, Default value : 25

Responses
200

Success

400

Bad Request

401

Unauthorized

get/products
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/products?searchTerm=&title=&description=&category=Standard&productType=Device&tags=&status=All&mode=All&skip=0&take=25' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Get product by Id

Request
Security:
Bearer
path Parameters
productId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

get/products/{productId}
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/products/{productId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Get variants by product Id

Request
Security:
Bearer
path Parameters
productId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

get/products/{productId}/variants
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/products/{productId}/variants' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Add product image.

Request
Security:
Bearer
path Parameters
productId
required
string
Request Body schema: multipart/form-data
formFile
string <binary>
Responses
200

Success

400

Bad Request

401

Unauthorized

post/products/{productId}/images
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/products/{productId}/images' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F formFile=string
Response samples
text/plain
text/plain
application/json
text/json
No sample

Remove product image.

Request
Security:
Bearer
path Parameters
productId
required
string
productImageId
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

post/products/{productId}/images/{productImageId}
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/products/{productId}/images/{productImageId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
text/plain
text/plain
application/json
text/json
No sample

Provisioning

Gets the RF Device Type listing

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

get/devices/rf/device-types
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/devices/rf/device-types \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "items": [
    ]
}

Checkout order for provisioning

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to checkout for provisioning

Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/checkout
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/checkout' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Release order from provisioning

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to release from provisioning

Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/provisioning-release
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/provisioning-release' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Complete provisioning of order

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order to complete provisioning

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

note
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/provisioning-complete
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "note": "string"
}
Response samples
application/json
{
  • "value": true
}

Checkout line item for provisioning

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item to checkout for provisioning

Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/line-items/{lineItemId}/provisioning-checkout
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/line-items/{lineItemId}/provisioning-checkout' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Release line item from provisioning

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item to release from provisioning

Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/line-items/{lineItemId}/provisioning-release
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/line-items/{lineItemId}/provisioning-release' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "orderId": "string",
  • "contractLineItemId": "string",
  • "productId": "string",
  • "variantProductId": "string",
  • "productCode": "string",
  • "provisioningNeeded": true,
  • "provisioningTypes": [
    ],
  • "provisioningOrder": 0,
  • "orderLineItemStatusId": 0,
  • "weight": 0,
  • "provisioningData": {
    },
  • "provisioningInfo": {
    },
  • "priceSelection": {
    },
  • "audit": {
    }
}

Complete provisioning of line item

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item to complete provisioning

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

object or null
note
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/line-items/{lineItemId}/provisioning-complete
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "provisioningData": {
    },
  • "note": "string"
}
Response samples
application/json
{
  • "value": true
}

Get line items provisioning type details

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item to complete provisioning

Responses
200

Success

400

Bad Request

401

Unauthorized

get/orders/{orderId}/line-items/{lineItemId}/provisioning-type
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/orders/{orderId}/line-items/{lineItemId}/provisioning-type' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "items": [
    ]
}

Create the subscriber’s XMIT in Rapid

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item

Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/line-items/{lineItemId}/xmit
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/line-items/{lineItemId}/xmit' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Deactivate the subscriber’s XMIT in Rapid

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

reason
required
integer <int32>
description
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

delete/orders/{orderId}/line-items/{lineItemId}/xmit
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "reason": 0,
  • "description": "string"
}
Response samples
application/json
{
  • "value": true
}

Update provisioning data for a line item

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

object or null
Responses
200

Success

400

Bad Request

401

Unauthorized

put/orders/{orderId}/line-items/{lineItemId}/provisioning-data
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "provisioningData": {
    }
}
Response samples
application/json
{
  • "value": true
}

Delete provisioning data for a line item

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item

code
required
string

The provisioning attribute code

Responses
200

Success

400

Bad Request

401

Unauthorized

delete/orders/{orderId}/line-items/{lineItemId}/provisioning-data/{code}
Request samples
curl -i -X DELETE \
  'https://orders-dev.ecg-api.com/orders/{orderId}/line-items/{lineItemId}/provisioning-data/{code}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Provision/Purchase a Twilio Phone Line

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item

Responses
200

Success

400

Bad Request

401

Unauthorized

post/orders/{orderId}/line-items/{lineItemId}/provision-phone-line
Request samples
curl -i -X POST \
  'https://orders-dev.ecg-api.com/orders/{orderId}/line-items/{lineItemId}/provision-phone-line' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "success": true,
  • "error": {
    },
  • "result": {
    }
}

De-Provision the Twilio Phone Line

This API will remove the number from Rapid, release the number from Twilio and mark the line item as de-provisioned

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

reason
required
integer <int32>
description
string or null
Responses
200

Success

400

Bad Request

401

Unauthorized

delete/orders/{orderId}/line-items/{lineItemId}/de-provision-phone-line
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "reason": 0,
  • "description": "string"
}
Response samples
application/json
{
  • "value": true
}

Release the Phone Line from Twilio

This API will only release the number from Twilio

Request
Security:
Bearer
path Parameters
orderId
required
string

ID of the order

lineItemId
required
string

ID of the line item

Responses
200

Success

400

Bad Request

401

Unauthorized

delete/orders/{orderId}/line-items/{lineItemId}/release-phone-line
Request samples
curl -i -X DELETE \
  'https://orders-dev.ecg-api.com/orders/{orderId}/line-items/{lineItemId}/release-phone-line' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Get provisioning attributes

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

401

Unauthorized

get/attributes
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/attributes \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Sync Anelto provisioning data

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization

orderId
required
string

ID of the order

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

aneltoAccountNumber
required
string
Responses
200

Success

401

Unauthorized

post/organizations/{organizationId}/orders/{orderId}/anelto-pairs
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "aneltoAccountNumber": "string"
}
Response samples
application/json
{
  • "value": true
}

Check Anelto subscriber

Request
Security:
Bearer
path Parameters
organizationId
required
string
orderId
required
string
query Parameters
aneltoAccountNumber
string
Responses
200

Success

400

Bad Request

401

Unauthorized

get/organizations/{organizationId}/orders/{orderId}/check-anelto-subscriber
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/orders/{orderId}/check-anelto-subscriber?aneltoAccountNumber=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Create Anelto subscriber

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization

orderId
required
string

ID of the order

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

aneltoAccountNumber
string or null
iccid
required
string
imei
required
string
Responses
200

Success

400

Bad Request

401

Unauthorized

post/organizations/{organizationId}/orders/{orderId}/anelto-subscribers
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "aneltoAccountNumber": "string",
  • "iccid": "string",
  • "imei": "string"
}
Response samples
application/json
{
  • "value": true
}

Remove Anelto Subscriber

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization

orderId
required
string

ID of the order

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

reason
required
integer <int32>
description
string or null
Responses
200

Success

401

Unauthorized

delete/organizations/{organizationId}/orders/{orderId}/anelto-subscribers
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "reason": 0,
  • "description": "string"
}
Response samples
application/json
{
  • "value": true
}

De-Provision device/service

NOT FOR ANELTO and RRMS, there are dedicated APIs for Anelto and RRMS de-provisioning, use this for everything else

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization

orderId
required
string

ID of the order

lineItemId
required
string

ID of the order line item

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

reason
required
integer <int32>
description
string or null
Responses
200

Success

401

Unauthorized

delete/organizations/{organizationId}/orders/{orderId}/line-items/{lineItemId}/provision
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "reason": 0,
  • "description": "string"
}
Response samples
application/json
{
  • "value": true
}

Get line item provisioning info

Request
Security:
Bearer
path Parameters
organizationId
required
string

ID of the organization

orderId
required
string

ID of the order

lineItemId
required
string

ID of the order line item

Responses
200

Success

401

Unauthorized

get/organizations/{organizationId}/orders/{orderId}/line-items/{lineItemId}/provisioning
Request samples
curl -i -X GET \
  'https://orders-dev.ecg-api.com/organizations/{organizationId}/orders/{orderId}/line-items/{lineItemId}/provisioning' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "provisioningParameters": {
    },
  • "thirdPartyProvisioningInfo": {
    }
}

Gets the DeProvisioning Reason listing.

Request
Security:
Bearer
Responses
200

Success

401

Unauthorized

get/orders/deprovisioning-reason-listing
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/orders/deprovisioning-reason-listing \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

SeedData

Seed data to Mongo/Document DB

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

get/seed-data
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/seed-data \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Sync Organizations to Mongo/Document DB

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

get/sync-organizations
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/sync-organizations \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Sync People to Mongo/Document DB

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

get/sync-people
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/sync-people \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Clear Redis cache

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

get/clear-redis
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/clear-redis \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Publish all contracts

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

get/publish-contracts
Request samples
curl -i -X GET \
  https://orders-dev.ecg-api.com/publish-contracts \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

Re-Sync provisioned orders with Rapid and Addison

Request
Security:
Bearer
Responses
200

Success

400

Bad Request

post/re-sync-provisioned-orders
Request samples
curl -i -X POST \
  https://orders-dev.ecg-api.com/re-sync-provisioned-orders \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "value": true
}

TransferOrder

Transfer V1 order to V2

Request
Security:
Bearer
Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request's payload

organizationId
string or null
subscriberId
string or null
contractId
string or null
aneltoAccountNumber
string or null
aneltoUserName
string or null
aneltoPassword
string or null
Responses
200

Success

400

Bad Request

post/transfer-order
Request samples
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "organizationId": "string",
  • "subscriberId": "string",
  • "contractId": "string",
  • "aneltoAccountNumber": "string",
  • "aneltoUserName": "string",
  • "aneltoPassword": "string"
}
Response samples
application/json
{
  • "value": true
}