POST api/PimInventoryImport

Request Information

URI Parameters

None.

Body Parameters

InventoryImportModel

NameDescriptionTypeAdditional Information
SiteCode

Site Code

 string

None.
VerificationKey

Verification Key

 string

None.
TimestampUTC

Current Time in UTC format

 string

None.
APIUsername

Use it to get the API key from user table to verify the verification key (optional)

 string

None.
InventoryPlugin

Decides if a SQL transaction should be used for the process.

 string

None.
InventoryCode

External Inventory Code

 string

None.
JobID

Job ID (in EDI will be the Logic app Run ID or the blob path), use it for file storage location

 string

None.
ExtraJobParameter

Optional parameter that can be passed to Inventory Import API to be passed along. Used in cases like blob inventory import, so we can specify the source blob path.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "SiteCode": "sample string 1",
  "VerificationKey": "sample string 2",
  "TimestampUTC": "sample string 3",
  "APIUsername": "sample string 4",
  "InventoryPlugin": "sample string 5",
  "InventoryCode": "sample string 6",
  "JobID": "sample string 7",
  "ExtraJobParameter": "sample string 8"
}

application/xml, text/xml

Sample: 
<InventoryImportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.WebApi.Controllers.PIM">
  <APIUsername>sample string 4</APIUsername>
  <ExtraJobParameter>sample string 8</ExtraJobParameter>
  <InventoryCode>sample string 6</InventoryCode>
  <InventoryPlugin>sample string 5</InventoryPlugin>
  <JobID>sample string 7</JobID>
  <SiteCode>sample string 1</SiteCode>
  <TimestampUTC>sample string 3</TimestampUTC>
  <VerificationKey>sample string 2</VerificationKey>
</InventoryImportModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.
Message

string

None.
CorrelationId

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample: 
<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>