Deck Commerce Web API Help Page

Introduction

All APIs are compartmentalized on the component of the Deck Commerce system they affect. Use the prefix of the system you wish to target to start your search.

OmsLegacyOrderImport

API	Description
POST api/OmsLegacyOrderImport	Import new Legacy Orders.

PimCjCancellationFeed

API	Description
POST api/PimCjCancellationFeed

Authentication

API	Description
POST api/Authentication?timeStamp={timeStamp}&username={username}&publicKey={publicKey}	Creates a login token that gets passed with the DeckCommerce Login page URL so a user can login to DeckCommerce.

PimStorefrontCategoryAssignment

API	Description
POST api/PimStorefrontCategoryAssignment	No documentation available.

OmsRmaCreate

API	Description
POST api/OmsRmaCreate	Take the importOrder and process it. If its bad, send the errors back to the user.
POST api/OmsRmaCreate?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

OmsInvoiceUpdate

API	Description
POST api/OmsInvoiceUpdate	No documentation available.
POST api/OmsInvoiceUpdate?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

OmsTeamOrderSummarizedCollection

API	Description
POST api/OmsTeamOrderSummarizedCollection	API to Process or Cancel Team Orders

OmsGetReturnReasons

API	Description
POST api/OmsGetReturnReasons	Get OMS Return Reasons.

OmsMissingStorefrontOrderCheck

API	Description
POST api/OmsMissingStorefrontOrderCheck

ResponsysAllowEmailSend

API	Description
POST api/ResponsysAllowEmailSend	API method to send HTML email.

ConveyShipmentEvents

API	Description
POST api/ConveyShipmentEvents	No documentation available.

OmsCreateShipment

API	Description
POST api/OmsCreateShipment	API endpoint to submit a single ASN

OmsInboundAsn

API	Description
POST api/OmsInboundAsn	API endpoint to submit a single ASN
POST api/OmsInboundAsn?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

PimImageImport

API	Description
POST api/PimImageImport

OmsPreBackOrder

API	Description
POST api/OmsPreBackOrder	No documentation available.

PimDataReset

API	Description
POST api/PimDataReset

PimInventoryTransformMergeImport

API	Description
POST api/PimInventoryTransformMergeImport	Transform the data imported for inventory to a usable format and then perform the import.This may be a long running process depending on how much inventory was imported. Errors are placed in the Import.ExtInventoryFailed table. Once the data is transformed, it will merge the inventory.

OmsTeamOrderProcess

API to Process or Cancel Team Orders

API	Description
POST api/OmsTeamOrderProcess	API to Process or Cancel Team Orders

OmsRmaInboundReturn

API	Description
POST api/OmsRmaInboundReturn	No documentation available.
POST api/OmsRmaInboundReturn?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

OmsInboundItemStatusUpdate

API	Description
POST api/OmsInboundItemStatusUpdate	No documentation available.
POST api/OmsInboundItemStatusUpdate?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

Custom

API	Description
POST api/Custom

DataExport

API	Description
POST api/DataExport	No documentation available.

OmsAuthorizeLowerEnviromentPayment

API	Description
POST api/OmsAuthorizeLowerEnviromentPayment?logMessage={logMessage}	No documentation available.
POST api/OmsAuthorizeLowerEnviromentPayment?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

OmsSalesRecap

API	Description
POST api/OmsSalesRecap	No documentation available.

OmsOrderLinkAccount

API	Description
POST api/OmsOrderLinkAccount	Update an order with a new customer ID

OmsOrderSearch

API	Description
POST api/OmsOrderSearch	Add new order note to an existing order in OMS

PimInventoryClearForImport

API	Description
POST api/PimInventoryClearForImport	Clear out the GenericInventory Import. This should be done first before a GenericInventory Update.

OmsChannelAdvisorReturnAdjustment

API	Description
POST api/OmsChannelAdvisorReturnAdjustment	No documentation available.

GenericReportingData

API	Description
POST api/GenericReportingData

OmsMembership

API	Description
POST api/OmsMembership	No documentation available.

PimInboundProduct

API	Description
POST api/PimInboundProduct	No documentation available.

OmsEdi820

API	Description
POST api/OmsEdi820	No documentation available.

OmsChannelAdvisorOrderImport

API	Description
POST api/OmsChannelAdvisorOrderImport	No documentation available.

PimStorefrontCategory

API	Description
POST api/PimStorefrontCategory	No documentation available.

OmsTeamOrder

API to insert a new collection or update the group due date for an existing collection.

API	Description
POST api/OmsTeamOrder	API to insert a new collection or update the group due date for an existing collection.

PimGenericFlexibleDataFeed

API	Description
POST api/PimGenericFlexibleDataFeed

OmsRmaGenerateNumber

API	Description
POST api/OmsRmaGenerateNumber	No documentation available.

CalculateHeatmapData

API	Description
POST api/CalculateHeatmapData

PimProductMoveTemplate

API	Description
POST api/PimProductMoveTemplate

PimInventoryLoadFile

API	Description
POST api/PimInventoryLoadFile	Recieve a compressed (.zip) file with GenericInventory to import. Form post: TimestampUTC,SiteCode,VerificationKey,ImportFile Ensure enctype="multipart/form-data" is included.

PimInventoryLookup

API	Description
POST api/PimInventoryLookup	Perform inventory lookup for specified items passed in to API

OmsRmaCancel

API	Description
POST api/OmsRmaCancel	No documentation available.
POST api/OmsRmaCancel?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

OmsTeamOrderSummarizedDetails

API	Description
POST api/OmsTeamOrderSummarizedDetails	No documentation available.

OmsAddOrderNote

Add notes to orders in OMS

API	Description
POST api/OmsAddOrderNote	Add new order note to an existing order in OMS

PimInboundBulkProduct

API	Description
POST api/PimInboundBulkProduct	Update a single attribute on a list of products

OmsChargeback

API	Description
POST api/OmsChargeback	No documentation available.
POST api/OmsChargeback?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

OmsOrderHistory

API	Description
POST api/OmsOrderHistory	No documentation available.

PimImageImportJob

API	Description
POST api/PimImageImportJob	No documentation available.

OmsMinimumOrderQuantity

MOQ functions

API	Description
POST api/OmsMinimumOrderQuantity	Returns MOQ collection summary and status.

OmsIpn

API	Description
POST api/OmsIpn/{id}?version={version}	API to process IPN messages.

SingleSignOnEventProcessor

API	Description
POST api/SingleSignOnEventProcessor	API to query single sign-on IdP event logs for user events.

EmailTest

API	Description
GET api/EmailTest?itemStatusID={itemStatusID}	Lookup item status code given the item status id
POST api/EmailTest?type={type}	Wrapper around create instance to allow for testing with Mock data

OmsInboundReturn

Return item(s) on an OMS order.

API	Description
POST api/OmsInboundReturn	No documentation available.
POST api/OmsInboundReturn?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

OmsDssReporting

API	Description
POST api/OmsDssReporting	No documentation available.

PimProductRefresh

API	Description
POST api/PimProductRefresh	Load and save the products specified. This happens inline, so the request may be slow to respond.

PimInventoryImport

API	Description
POST api/PimInventoryImport

OmsShipmentRequestFromQueueForRetry

API	Description
POST api/OmsShipmentRequestFromQueueForRetry	No documentation available.

OmsFraudUpdate

API	Description
POST api/OmsFraudUpdate	No documentation available.

ShipwireInboundASN

API	Description
GET api/ShipwireInboundASN	No documentation available.
POST api/ShipwireInboundASN	No documentation available.
POST api/ShipwireInboundASN?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

OmsInboundOrder

API	Description
POST api/OmsInboundOrder	Take the importOrder and process it. If its bad, send the errors back to the user.
POST api/OmsInboundOrder?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

OmsGetReturnTypes

API	Description
POST api/OmsGetReturnTypes	Get OMS Return Types.

OmsInboundAsnFile

API	Description
POST api/OmsInboundAsnFile	No documentation available.

OmsIpnJobProcessing

API	Description
POST api/OmsIpnJobProcessing	API to Process payments pending settlement.

OmsEmailRetrigger

API	Description
POST api/OmsEmailRetrigger	No documentation available.
POST api/OmsEmailRetrigger?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}	Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

PimInventoryAdjustment

API	Description
POST api/PimInventoryAdjustment	No documentation available.