(v1.0) LS Central customerOrder API (1.0.0)

Download OpenAPI specification:

(v1.0) LS Central customerOrder API for Dynamics 365 Business Central. Published by the LS Central AL API pages at /api/lsRetail/customerOrder/v1.0.

Currency Exchange Rate

Exposes the exchange rate for a currency Code. Provided as a read-only OData v4 entity replacing the generic RetailWebServices GET_TABLE_DATA read of table "Currency Exchange Rate". This release is read-only (Phase 1): Insert, Modify, and Delete are not supported over the API; exchange rates are maintained through the LS Central back-office UI. A future phase may add write support.

Get currencyExchangeRates from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "currencyCode" "startingDate" "exchangeRateAmount" "adjustmentExchRateAmount" "relationalCurrencyCode" "relationalExchRateAmount" "fixExchangeRateAmount" "relationalAdjmtExchRateAmt" "lscPosExchangeRateAmount" "lscPosRelExchRateAmount" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get currencyExchangeRates from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

currencyExchangeRate-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of currencyExchangeRate

query Parameters
$select
Array of strings unique
Items Enum: "id" "currencyCode" "startingDate" "exchangeRateAmount" "adjustmentExchRateAmount" "relationalCurrencyCode" "relationalExchRateAmount" "fixExchangeRateAmount" "relationalAdjmtExchRateAmt" "lscPosExchangeRateAmount" "lscPosRelExchRateAmount" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "currencyCode": "string",
  • "startingDate": "2019-08-24",
  • "exchangeRateAmount": null,
  • "adjustmentExchRateAmount": null,
  • "relationalCurrencyCode": null,
  • "relationalExchRateAmount": null,
  • "fixExchangeRateAmount": "Currency",
  • "relationalAdjmtExchRateAmt": null,
  • "lscPosExchangeRateAmount": null,
  • "lscPosRelExchRateAmount": null,
  • "lastModifiedDateTime": null
}

Default Shipping Agent

Exposes the per-store default Shipping Agent / Agent Service assignment — one row per store, plus a single fallback row with a blank storeNo that applies to all stores without their own row — as a read-only OData v4 entity. Replaces the legacy COShipAgentsInfoGet SOAP web service (codeunit LSCCOShipAgentsInfoGet / LSCCOShipAgentsInfoGetUtils), which returned every "LSC CO Default Shipping Agent" row, every Shipping Agent, and every Shipping Agent Service unfiltered in one payload. This entity is a simple flat projection: it returns only the storeNo/shippingAgentCode/agentServiceCode assignment, with no nested navigation. A consumer that needs the full Shipping Agent or Shipping Agent Service detail (name, internet address, account number, description, shipping time, etc.) makes a separate GET against the standalone LSC Shipping Agent API or LSC Shipping Agent Service API, filtering by the shippingAgentCode / agentServiceCode value returned here. This release is read-only: Insert, Modify, and Delete are not supported over the API; default shipping agent assignments are maintained through the LS Central back-office UI. The bound action resolveEffective(storeNo) implements the store-else-blank-fallback resolution used by the Customer Order POS session (Customer Order Session.GetShippingAgents): it looks for a row matching the given storeNo, and if none exists, falls back to the row with a blank storeNo; it errors if neither exists. This resolution logic is NEW, additive server-side convenience added by this API — the legacy SOAP operation itself performs no store filtering at all, so resolveEffective is not a byte-for-byte replication of legacy behavior. On success, the action repoints the response at the resolved defaultShippingAgent entity, so a caller can immediately GET it and then follow up with separate calls to LSC Shipping Agent API / LSC Shipping Agent Service API for the full detail.

Get defaultShippingAgents from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "storeNo" "shippingAgentCode" "agentServiceCode" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique
Items Value: "shippingAgentService"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get defaultShippingAgents from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

defaultShippingAgent-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of defaultShippingAgent

query Parameters
$select
Array of strings unique
Items Enum: "id" "storeNo" "shippingAgentCode" "agentServiceCode" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique
Items Value: "shippingAgentService"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "storeNo": null,
  • "shippingAgentCode": null,
  • "agentServiceCode": null,
  • "lastModifiedDateTime": null,
  • "shippingAgentService": {
    }
}

Invoke action resolveEffective

Resolves the effective default shipping agent for a given store, applying the same store-else-blank-fallback logic used by the Customer Order POS session: looks for a row matching storeNo, and if none exists, falls back to the row with a blank storeNo (the all-stores default). Errors if neither a store-specific nor a fallback row exists. Repoints the response at the resolved defaultShippingAgent entity — follow up with separate GET calls to LSC Shipping Agent API / LSC Shipping Agent Service API, filtering by the returned shippingAgentCode / agentServiceCode, for the full graph. This is new, additive server-side resolution logic; the legacy COShipAgentsInfoGet SOAP operation it replaces performs no store filtering at all.

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

defaultShippingAgent-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of defaultShippingAgent

Request Body schema: application/json

Action parameters

storeNo
null or string

Responses

Request samples

Content type
application/json
{
  • "storeNo": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Shipping Agent Service

Exposes Shipping Agent Services (standard table) — the shipping services offered by a shipping agent, including code, description, and expected shipping time — as a read-only OData v4 entity, nested under the parent shippingAgents entity. Replaces the legacy RetailWebServices GetShippingAgentService(agentId) operation (GetGeneralWebRequestXML("Shipping Agent Services", "Shipping Agent Code", agentId)), a per-agent read. This release is read-only: Insert, Modify, and Delete are not supported over the API; shipping agent services are maintained through the LS Central back-office UI.

Get shippingAgentService from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

defaultShippingAgent-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of defaultShippingAgent

query Parameters
$select
Array of strings unique
Items Enum: "id" "shippingAgentCode" "code" "description" "shippingTime" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "shippingAgentCode": "string",
  • "code": "string",
  • "description": null,
  • "shippingTime": null,
  • "lastModifiedDateTime": null
}

Get shippingAgentService from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

salesShipment-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of salesShipment

query Parameters
$select
Array of strings unique
Items Enum: "id" "shippingAgentCode" "code" "description" "shippingTime" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "shippingAgentCode": "string",
  • "code": "string",
  • "description": null,
  • "shippingTime": null,
  • "lastModifiedDateTime": null
}

Get shippingAgentServices from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

shippingAgent-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of shippingAgent

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "shippingAgentCode" "code" "description" "shippingTime" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get shippingAgentServices from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

shippingAgent-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of shippingAgent

shippingAgentService-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of shippingAgentService

query Parameters
$select
Array of strings unique
Items Enum: "id" "shippingAgentCode" "code" "description" "shippingTime" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "shippingAgentCode": "string",
  • "code": "string",
  • "description": null,
  • "shippingTime": null,
  • "lastModifiedDateTime": null
}

Get shippingAgentServices from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "shippingAgentCode" "code" "description" "shippingTime" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get shippingAgentServices from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

shippingAgentService-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of shippingAgentService

query Parameters
$select
Array of strings unique
Items Enum: "id" "shippingAgentCode" "code" "description" "shippingTime" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "shippingAgentCode": "string",
  • "code": "string",
  • "description": null,
  • "shippingTime": null,
  • "lastModifiedDateTime": null
}

Return Policy

Exposes the store/item/variant scoped return policy rules — whether refunds are allowed, what manager privileges are required, the allowed refund period, and the messages shown to the customer — as a read-only OData v4 entity. Replaces the legacy GetReturnPolicy SOAP web service (codeunit LSCGetReturnPolicyUtils and the GetReturnPolicyXML xmlport), which callers queried by supplying explicit Store No. / Store Group Code / Item Category Code / Retail Product Code / Item No. / Variant Code / Variant Dimension 1 Code parameters, with a blank parameter meaning wildcard. This API reproduces that same scoping behavior declaratively: filter on storeNo, storeGroupCode, itemCategoryCode, retailProductCode, itemNo, variantCode, and variantDimension1Code — all plain, independently filterable OData columns — to retrieve exactly the return policies that would have matched the equivalent SOAP request. This release is read-only (Phase 1): Insert, Modify, and Delete are not supported over the API; return policies are maintained through the LS Central back-office UI. A future phase may add write support.

Get returnPolicies from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "storeNo" "storeGroupCode" "itemCategoryCode" "retailProductCode" "itemNo" "variantCode" "variantDimension1Code" "refundNotAllowed" "managerPrivileges" "refundPeriodLength" "message1" "message2" "returnPolicyHTML" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get returnPolicies from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

returnPolicy-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of returnPolicy

query Parameters
$select
Array of strings unique
Items Enum: "id" "storeNo" "storeGroupCode" "itemCategoryCode" "retailProductCode" "itemNo" "variantCode" "variantDimension1Code" "refundNotAllowed" "managerPrivileges" "refundPeriodLength" "message1" "message2" "returnPolicyHTML" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "storeNo": null,
  • "storeGroupCode": null,
  • "itemCategoryCode": null,
  • "retailProductCode": null,
  • "itemNo": null,
  • "variantCode": null,
  • "variantDimension1Code": null,
  • "refundNotAllowed": null,
  • "managerPrivileges": null,
  • "refundPeriodLength": null,
  • "message1": null,
  • "message2": null,
  • "returnPolicyHTML": null,
  • "lastModifiedDateTime": null
}

Sales Shipment

Exposes posted Sales Shipment Header records as an OData v4 entity, replacing the legacy SOAP operations SalesShipmentListGet and SalesShipmentUpdate (18-month guaranteed coexistence — the legacy web service is untouched). This release supports GET and PATCH only; there are no bound or unbound actions. Only shippingAgentCode, shippingAgentServiceCode, and packageTrackingNo are writable, matching the legacy SalesShipmentUpdate operation''s parity exactly — no other field may be patched. lscCustomerOrderId can be used as an OData filter to scope the results to the shipments of one Customer Order document, mirroring the legacy operation''s own DocumentID-scoped read.

Get salesShipments from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "no" "sellToCustomerNo" "sellToCustomerName" "postingDate" "shipmentDate" "shipToCode" "shipToName" "shippingAgentCode" "shippingAgentServiceCode" "packageTrackingNo" "lscCustomerOrderId" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique
Items Value: "shippingAgentService"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get salesShipments from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

salesShipment-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of salesShipment

query Parameters
$select
Array of strings unique
Items Enum: "id" "no" "sellToCustomerNo" "sellToCustomerName" "postingDate" "shipmentDate" "shipToCode" "shipToName" "shippingAgentCode" "shippingAgentServiceCode" "packageTrackingNo" "lscCustomerOrderId" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique
Items Value: "shippingAgentService"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "sellToCustomerNo": "string",
  • "sellToCustomerName": null,
  • "postingDate": null,
  • "shipmentDate": null,
  • "shipToCode": null,
  • "shipToName": null,
  • "shippingAgentCode": null,
  • "shippingAgentServiceCode": null,
  • "packageTrackingNo": null,
  • "lscCustomerOrderId": null,
  • "lastModifiedDateTime": null,
  • "shippingAgentService": {
    }
}

Update the navigation property salesShipments in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

salesShipment-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of salesShipment

Request Body schema: application/json
required

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
no
null or string <= 20 characters
sellToCustomerNo
string <= 20 characters
sellToCustomerName
null or string <= 100 characters
postingDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
shipmentDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
shipToCode
null or string <= 10 characters
shipToName
null or string <= 100 characters
shippingAgentCode
null or string <= 10 characters
shippingAgentServiceCode
null or string <= 10 characters
packageTrackingNo
null or string <= 50 characters
lscCustomerOrderId
null or string <= 20 characters
lastModifiedDateTime
null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
(shippingAgentService (null or object))

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "sellToCustomerNo": "string",
  • "sellToCustomerName": null,
  • "postingDate": null,
  • "shipmentDate": null,
  • "shipToCode": null,
  • "shipToName": null,
  • "shippingAgentCode": null,
  • "shippingAgentServiceCode": null,
  • "packageTrackingNo": null,
  • "lscCustomerOrderId": null,
  • "lastModifiedDateTime": null,
  • "shippingAgentService": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Shipping Agent

Exposes Shipping Agent (standard table) master data — code, name, internet address, and account number — as a read-only OData v4 entity. Replaces the legacy RetailWebServices ReplicateShippingAgent(...) operation (GetGeneralWebRequestXML("Shipping Agent"), a full unfiltered read). The nested shippingAgentServices part replaces the per-agent GetShippingAgentService(agentId) call. This release is read-only: Insert, Modify, and Delete are not supported over the API; shipping agents are maintained through the LS Central back-office UI.

Get shippingAgents from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "code" "name" "internetAddress" "accountNo" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique
Items Value: "shippingAgentServices"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get shippingAgents from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

shippingAgent-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of shippingAgent

query Parameters
$select
Array of strings unique
Items Enum: "id" "code" "name" "internetAddress" "accountNo" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique
Items Value: "shippingAgentServices"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": null,
  • "internetAddress": null,
  • "accountNo": null,
  • "lastModifiedDateTime": null,
  • "shippingAgentServices": [
    ]
}

Company

Get entities from companies

Authorizations:
oAuth2basicAuth
query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "systemVersion" "timestamp" "name" "displayName" "businessProfileId" "systemCreatedAt" "systemCreatedBy" "systemModifiedAt" "systemModifiedBy"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "returnPolicies" "currencyExchangeRates" "shippingAgents" "shippingAgentServices" "defaultShippingAgents" "salesShipments"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from companies by key

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$select
Array of strings unique
Items Enum: "id" "systemVersion" "timestamp" "name" "displayName" "businessProfileId" "systemCreatedAt" "systemCreatedBy" "systemModifiedAt" "systemModifiedBy"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "returnPolicies" "currencyExchangeRates" "shippingAgents" "shippingAgentServices" "defaultShippingAgents" "salesShipments"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "systemVersion": null,
  • "timestamp": null,
  • "name": null,
  • "displayName": null,
  • "businessProfileId": null,
  • "systemCreatedAt": null,
  • "systemCreatedBy": null,
  • "systemModifiedAt": null,
  • "systemModifiedBy": null,
  • "returnPolicies": [
    ],
  • "currencyExchangeRates": [
    ],
  • "shippingAgents": [
    ],
  • "shippingAgentServices": [
    ],
  • "defaultShippingAgents": [
    ],
  • "salesShipments": [
    ]
}