CRM in Cloud Web API documentations

Security

This controller works under the system security rules and constraints.
For more details, refer to the Authentication section

Note

The following guidelines are intended to illustrate the features and features of this Web API controller.

Aliases

This controller can be invoked by other names besides the default one.

This means that, referring to the routing grammar ({schema}://{host}/api/{version}/{controller}/{details}/{action}/{id}?{querystring}) it is possible to use a different fragment for the {controller} component.

Below is the list of these aliases for the fragment {controller}, sorted by suggested preference of use.

Alias	Path
Orders	/api/v1/Orders
Order	/api/v1/Order

Authentication

JWT Token

In order to invoke the REST API, it is necessary to obtain an authentication token via the appropriate service /Auth/Login

For more details, please see the appropriate section of the documentations.

Bearer Authentication

Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens.

For more details, please see the appropriate section of the documentations.

Identification of the calling application

Some of the REST API functions can only be used if (in addition to proper user authentication) a declaration of the calling application is also performed.

For more details, please see the appropriate section of the documentations.

Actions & Paths

These are the REST actions that can be performed via the Web API infrastructure.
The actions are grouped by "topic".
Click on a "topic" to view the different actions contained in it.

Each action corresponds to a method in the class of the Web API controller, and a set of routing paths that can be used to invoke it.

Explore by topics

Topic name	Most commonly used actions
CRUD	/api/v1/Order/CreateOrUpdate /api/v1/Order/ /api/v1/Order/Exists /api/v1/Order/ /api/v1/Order/Humanize /api/v1/Order/GetFull /api/v1/Order/GetNewInstance
Multiple CRUD	/api/v1/Order/MultipleDelete /api/v1/Order/MultipleExists /api/v1/Order/MultipleGet
External References	/api/v1/Order/SearchIdsByExternalReference /api/v1/Order/GetByExternalReference /api/v1/Order/DeleteByExternalReference /api/v1/Order/MapByExternalReference /api/v1/Order/ResetExternalReferences /api/v1/Order/UnmapByExternalReference /api/v1/Order/GetIdsMappedByExternalReference /api/v1/Order/GetItemsMappedByExternalReference /api/v1/Order/GetIdsNotMappedByExternalReference /api/v1/Order/GetIdsByExternalReference /api/v1/Order/GetItemsNotMappedByExternalReference
Misc	/api/v1/Order/RequestedByChanged /api/v1/Order/OnAnagraphicChanged /api/v1/Order/GetPriceListCurrency /api/v1/Order/SendEmailWithPrintTemplate /api/v1/Order/OnGetNewEmptyGroupRow /api/v1/Order/OnGroupByRowType /api/v1/Order/OnGroupByProductCategory /api/v1/Order/OnDiscountFormulaGroupingChanged /api/v1/Order/OnGroupTaxableAmountWithDiscountChanged /api/v1/Order/GetInfo /api/v1/Order/AddProductsByCode /api/v1/Order/CloneRowsGroups /api/v1/Order/ImportRows /api/v1/Order/GetNewRowInstance /api/v1/Order/ApplyCalculateTotalDocument /api/v1/Order/ApplyCalculateTotalDocumentWithFooterTotals /api/v1/Order/NewEmptyRow /api/v1/Order/CatalogCodeChanged /api/v1/Order/LinkedProducts /api/v1/Order/PriceListChanged /api/v1/Order/UnitPriceChanged /api/v1/Order/QtaChanged /api/v1/Order/UnitMeasureChanged /api/v1/Order/TaxCodeChanged /api/v1/Order/DiscountFormulaChanged /api/v1/Order/CostChanged /api/v1/Order/GainChanged /api/v1/Order/PercentageGainChanged /api/v1/Order/ProcessOnChangeListId /api/v1/Order/ProcessOnChangeCurrency /api/v1/Order/ExportRowsInExcel /api/v1/Order/RebuildGrouping /api/v1/Order/RecalcDocumentTotal /api/v1/Order/Templates /api/v1/Order/HtmlPreview /api/v1/Order/PrintHtml /api/v1/Order/GetDownloadUrl /api/v1/Order/GetPostDownloadUrl /api/v1/Order/Archive /api/v1/Order/AsDataProduct /api/v1/Order/GetBoDeleteModes /api/v1/Order/FreeFields /api/v1/Order/GetHash /api/v1/Order/PrintableFields /api/v1/Order/Photo /api/v1/Order/Recent /api/v1/Order/GetSample
OData	/api/v1/Order/Count /api/v1/Order/SearchIds /api/v1/Order/Search
Preview	/api/v1/Order/Previews /api/v1/Order/Preview
Swagger	/api/v1/Order/GetDataProductSchema /api/v1/Order/GetPolymorphicSchema /api/v1/Order/GetPolymorphicStandardSchema /api/v1/Order/GetStandardSchema /api/v1/Order/GetSwagger

GET: /api/v1/Order/

Routing template:

/api/{version}/Order/

Produces:

HTTP 200: Int64 as application/json
HTTP 200: Int64 as text/json
HTTP 200: Int64 as application/json;IEEE754Compatible=false
HTTP 200: Int64 as application/json;IEEE754Compatible=true
HTTP 200: Int64 as application/xml
HTTP 200: Int64 as text/plain
HTTP 200: Int64 as application/octet-stream

Name	Type	Required	In	Features
id	integer	YES	Path	Format: int64
template	string	NO	Query
request	OrderPrintableRequest	NO	Query

Name	Type	Required	In	Features
insertPosition	integer	NO	Query	Format: int32
overrideCurrent	boolean	NO	Query
lang	string	NO	Query

Name	Type	Required	In
exportDescription	boolean	NO	Query
exportDescriptionNewLine	boolean	NO	Query
exportExtensions	boolean	NO	Query
exportFreeFields	boolean	NO	Query

Name	Type	Required	In	Features
honorAcceptLanguageHeader	boolean	NO	Query	Default: False
includeExplicitlyDeclaredVirtualProperties	boolean	NO	Query	Default: False

Name	Type	Required	In	Features
externalReference	string	NO	Query
excludeDeletedItems	boolean	NO	Query

Name	Type	Required	In	Features
serializePropertiesAsDictionary	boolean	NO	Query	Default: True
honorAcceptLanguageHeader	boolean	NO	Query	Default: False
generateSample	boolean	NO	Query	Default: False
sampleGenerationStrategy	SampleGenerationStrategy	NO	Query
useExtensions	boolean	NO	Query	Default: True
includeExplicitlyDeclaredVirtualProperties	boolean	NO	Query	Default: False

Name	Type	Required	In	Features
force	boolean	NO	Query	Default: False
sampleGenerationStrategy	SampleGenerationStrategy	NO	Query
useExtensions	boolean	NO	Query	Default: True

Name	Type	Required	In	Features
taxableAmountWithDiscount	number	NO	Query	Format: double
extensionPartIdx	integer	NO	Query	Format: int32
decimals	integer	NO	Query	Default: 2 Format: int32

Name	Type	Required	In	Features
includeFull	boolean	NO	Query	Default: True
includeNesting	boolean	NO	Query	Default: True

Name	Type	Required	In	Features
crossId	integer	NO	Query	Format: int64
crossType	BusinessObjectType	NO	Query
erpType	BusinessObjectType	NO	Query

Name	Type	Required	In	Features
filter	string	NO	Query
orderBy	string	NO	Query
skip	integer	NO	Query	Format: int64
top	integer	NO	Query	Format: int64
select	string	NO	Query

Name	Type	Required	In	Features
parentId	integer	NO	Query	Format: int64
parentType	BusinessObjectType	NO	Query
templateName	string	NO	Query

Name	Description
AccountAccessLevel	Account Access Level
ActiveModules	Active Modules
AddProductsByCodeRequest	Add Products By Code Request
AddressAccuracy	Address Accuracy
BoDeleteMode	Bo Delete Mode
Boolean	Boolean
BusinessObjectInvoker	Business Object Invoker
BusinessObjectLoadedType	Business Object Loaded Type
BusinessObjectType	Business Object Type
CatalogPriceListUsage	Catalog Price List Usage
CatalogType	Catalog Type
CloneRowsGroupsRequest	Clone Rows Groups Request
CRMTables	CRM Tables
DefaultDocumentCategories	Default Document Categories
DeleteItemResult	Delete Item Result
ErpGroupingType	Erp Grouping Type
ERPRowDTO	ERP Row
ERPRowGroupingDTO	ERP Row Grouping
ERPRowGroupingExtensionDTO	ERP Row Grouping Extension
ERPRowType	ERP Row Type
ExistsItemResult	Exists Item Result
ExternalReferenceDTO	External Reference
FileCrossAttributes	File Cross Attributes
FileCrossTypes	File Cross Types
FilePreview	File Preview
FreeFieldsBOItemDTO	Free Fields BO Item
FreeFieldsBOItemLocalizingDTO	Free Fields BO Item Localizing
FreeFieldsBOTreeItemDTO	Free Fields BO Tree Item
FreeFieldsType	Free Fields Type
GetIdsMappedByExternalReferenceRequest	Get Ids Mapped By External Reference Request
GetItemResult`1[]	Get Item Result`1
GetItemsMappedByExternalReferenceRequest	Get Items Mapped By External Reference Request
Gravity	Gravity
IBundle	Bundle
ICatalogAlternativeUnitBO	Catalog Alternative Unit BO
ICatalogBO	Catalog BO
ICatalogCodeChangeResponse	Catalog Code Change Response
ICatalogProductPriceBO	Catalog Product Price BO
ICrmBusinessObjects	Crm Business Objects
IDirection	Direction
IDocumentReference	Document Reference
IErpExportRowsExcelInfo	Erp Export Rows Excel Info
IERPRow	ERP Row
IERPRowExtension	ERP Row Extension
IERPRowGrouping	ERP Row Grouping
IERPRowGroupingExtension	ERP Row Grouping Extension
IExternalReference	External Reference
IFileCross	File Cross
IFreeFieldItemLocalizing	Free Field Item Localizing
IFreeFieldsItem	Free Fields Item
IGeo	Geo
ILocalizing	Localizing
ILocation	Location
ImportRowsRequest	Import Rows Request
object	Int 32
InvoiceType	Invoice Type
IPackageResponse	Package Response
IPrintTemplate	Print Template
IQueryFragment	Query Fragment
IQueryMutators	Query Mutators
IQueryPaging	Query Paging
ISimpleCatalogLink	Simple Catalog Link
IStorageBO	Storage BO
ITaxSummary	Tax Summary
ITotalDocumentResult	Total Document Result
ITreeItem	Tree Item
IUserConfig	User Config
LinkItem	Link Item
LiquidStruct	Liquid Struct
LocalizeType	Localize Type
LocalizingDTO	Localizing
LoggedStatus	Logged Status
LoginResult	Login Result
MapExternalReferenceRequest	Map External Reference Request
MessageCode	Message Code
MultipleDeleteModel	Multiple Delete Model
MultipleExistsModel	Multiple Exists Model
MultipleGetModel	Multiple Get Model
OrderDTO	Order
OrderPrintableRequest	Order Printable Request
OrderStage	Order Stage
PrintHtmlRequest	Print Html Request
PrintTemplateDTO	Print Template
QueryFragmentKind	Query Fragment Kind
RecentRouteType	Recent Route Type
RowContentType	Row Content Type
RowTypeGiftVatMode	Row Type Gift Vat Mode
SampleGenerationStrategy	Sample Generation Strategy
StandardSchemaVersion	Standard Schema Version
StoragePermission	Storage Permission
SubAccountType	Sub Account Type
Template	Template
TypeOfService	Type Of Service

APIv1EnglishOrder

Order

Security

Note

Aliases

Authentication

JWT Token

Bearer Authentication

Identification of the calling application

Actions & Paths

GET: /api/v1/Order/

Routing template:

Produces:

Response: 200 (Success) ApiActionResult

Samples

Try this !

DELETE: /api/v1/Order/{id}

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Try this !

GET: /api/v1/Order/{id}

Parameters:

Produces:

Response: 200 (Success) OrderDTO

Samples

Try this !

GET: /api/v1/Order/{id}/Archive

Parameters:

Produces:

Response: 400 (Bad Request) integer

Samples

Try this !

GET: /api/v1/Order/{id}/AsDataProduct

Parameters:

Produces:

Response: 200 (Success) OrderDTO

Samples

Try this !

GET: /api/v1/Order/{id}/Exists

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Try this !

GET: /api/v1/Order/{id}/FreeFields

Parameters:

Produces:

Response: 200 (Success) FreeFieldsBOItemDTO

Samples

Try this !

GET: /api/v1/Order/{id}/GetDownloadUrl

Parameters:

Produces:

Response: 400 (Bad Request) string

Samples

Try this !

GET: /api/v1/Order/{id}/GetFull

Parameters:

Produces:

Response: 200 (Success) OrderDTO

Samples

Try this !

GET: /api/v1/Order/{id}/GetHash

Parameters:

Produces:

Response: 200 (Success) String

Samples

Try this !

GET: /api/v1/Order/{id}/GetPostDownloadUrl

Parameters:

Produces:

Response: 400 (Bad Request) string

Samples

Try this !

POST: /api/v1/Order/{id}/HtmlPreview

Parameters:

Produces:

Response: 200 (Success) String

API v1 English Order