POST api/V3/PrimaryOrders/UploadPrimaryOrders

API to post external Primary Orders in the SFA

Request Information

URI Parameters

None.

Body Parameters

List of PrimaryOrders to be created (Max 100)

Collection of V3.PrimaryOrderInput
NameDescriptionTypeAdditional information
OrderNumber

Order Number

string

Required

DistributorErpId

Distributor ErpId

string

Required

OrderDate

Order Date

date

Required

SkuDetails

SkuDetails

Collection of SkuDetails

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "OrderNumber": "sample string 1",
    "DistributorErpId": "sample string 2",
    "OrderDate": "2025-04-04T05:21:17.3780902+00:00",
    "SkuDetails": [
      {
        "ProductErpId": "sample string 1",
        "Quantity": 2.1,
        "Unit": "sample string 3",
        "NetAmount": 4.1
      },
      {
        "ProductErpId": "sample string 1",
        "Quantity": 2.1,
        "Unit": "sample string 3",
        "NetAmount": 4.1
      }
    ]
  },
  {
    "OrderNumber": "sample string 1",
    "DistributorErpId": "sample string 2",
    "OrderDate": "2025-04-04T05:21:17.3780902+00:00",
    "SkuDetails": [
      {
        "ProductErpId": "sample string 1",
        "Quantity": 2.1,
        "Unit": "sample string 3",
        "NetAmount": 4.1
      },
      {
        "ProductErpId": "sample string 1",
        "Quantity": 2.1,
        "Unit": "sample string 3",
        "NetAmount": 4.1
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfPrimaryOrderInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <PrimaryOrderInput>
    <DistributorErpId>sample string 2</DistributorErpId>
    <OrderDate>2025-04-04T05:21:17.3780902+00:00</OrderDate>
    <OrderNumber>sample string 1</OrderNumber>
    <SkuDetails>
      <SkuDetails>
        <NetAmount>4.1</NetAmount>
        <ProductErpId>sample string 1</ProductErpId>
        <Quantity>2.1</Quantity>
        <Unit>sample string 3</Unit>
      </SkuDetails>
      <SkuDetails>
        <NetAmount>4.1</NetAmount>
        <ProductErpId>sample string 1</ProductErpId>
        <Quantity>2.1</Quantity>
        <Unit>sample string 3</Unit>
      </SkuDetails>
    </SkuDetails>
  </PrimaryOrderInput>
  <PrimaryOrderInput>
    <DistributorErpId>sample string 2</DistributorErpId>
    <OrderDate>2025-04-04T05:21:17.3780902+00:00</OrderDate>
    <OrderNumber>sample string 1</OrderNumber>
    <SkuDetails>
      <SkuDetails>
        <NetAmount>4.1</NetAmount>
        <ProductErpId>sample string 1</ProductErpId>
        <Quantity>2.1</Quantity>
        <Unit>sample string 3</Unit>
      </SkuDetails>
      <SkuDetails>
        <NetAmount>4.1</NetAmount>
        <ProductErpId>sample string 1</ProductErpId>
        <Quantity>2.1</Quantity>
        <Unit>sample string 3</Unit>
      </SkuDetails>
    </SkuDetails>
  </PrimaryOrderInput>
</ArrayOfPrimaryOrderInput>

Response Information

Resource Description

Response Description with message and GUID or, ErrorMessage as String

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.