POST api/SparePartTracking/CreateSparePartRequest

Request Information

URI Parameters

None.

Body Parameters

CreateSparePartRequestRequest
NameDescriptionTypeAdditional information
UserId

integer

None.

OwnerUserId

integer

None.

StoreId

integer

None.

GenerateReturnLabel

boolean

None.

GenerateSendLabel

boolean

None.

ReplacementType

SparePartReplacementType

None.

Items

Collection of SparePartOrderItem

None.

Reason

string

None.

CustomerName

string

None.

CustomerContact

string

None.

OrderNumber

string

None.

Comment

string

None.

ShippingAddressText

string

None.

CustomerAddress

SparePartAddressModel

None.

Documents

Collection of SparePartFileUpload

None.

Request Formats

application/json, text/json

Sample:
{
  "UserId": 1,
  "OwnerUserId": 2,
  "StoreId": 1,
  "GenerateReturnLabel": true,
  "GenerateSendLabel": true,
  "ReplacementType": 0,
  "Items": [
    {
      "SparePartId": 1,
      "Qty": 2.0,
      "ReplacementType": 0
    },
    {
      "SparePartId": 1,
      "Qty": 2.0,
      "ReplacementType": 0
    }
  ],
  "Reason": "sample string 3",
  "CustomerName": "sample string 4",
  "CustomerContact": "sample string 5",
  "OrderNumber": "sample string 6",
  "Comment": "sample string 7",
  "ShippingAddressText": "sample string 8",
  "CustomerAddress": {
    "RecipientName": "sample string 1",
    "Street": "sample string 2",
    "HouseNumber": "sample string 3",
    "PostCode": "sample string 4",
    "City": "sample string 5",
    "CountryCode": "sample string 6",
    "Phone": "sample string 7",
    "Email": "sample string 8"
  },
  "Documents": [
    {
      "FileName": "sample string 1",
      "ContentBase64": "sample string 2"
    },
    {
      "FileName": "sample string 1",
      "ContentBase64": "sample string 2"
    }
  ]
}

text/html

Sample:
{"UserId":1,"OwnerUserId":2,"StoreId":1,"GenerateReturnLabel":true,"GenerateSendLabel":true,"ReplacementType":0,"Items":[{"SparePartId":1,"Qty":2.0,"ReplacementType":0},{"SparePartId":1,"Qty":2.0,"ReplacementType":0}],"Reason":"sample string 3","CustomerName":"sample string 4","CustomerContact":"sample string 5","OrderNumber":"sample string 6","Comment":"sample string 7","ShippingAddressText":"sample string 8","CustomerAddress":{"RecipientName":"sample string 1","Street":"sample string 2","HouseNumber":"sample string 3","PostCode":"sample string 4","City":"sample string 5","CountryCode":"sample string 6","Phone":"sample string 7","Email":"sample string 8"},"Documents":[{"FileName":"sample string 1","ContentBase64":"sample string 2"},{"FileName":"sample string 1","ContentBase64":"sample string 2"}]}

application/xml, text/xml

Sample:
<CreateSparePartRequestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Msa.Online.OrderbobApi.Models.SpareParts">
  <Comment>sample string 7</Comment>
  <CustomerAddress>
    <City>sample string 5</City>
    <CountryCode>sample string 6</CountryCode>
    <Email>sample string 8</Email>
    <HouseNumber>sample string 3</HouseNumber>
    <Phone>sample string 7</Phone>
    <PostCode>sample string 4</PostCode>
    <RecipientName>sample string 1</RecipientName>
    <Street>sample string 2</Street>
  </CustomerAddress>
  <CustomerContact>sample string 5</CustomerContact>
  <CustomerName>sample string 4</CustomerName>
  <Documents>
    <SparePartFileUpload>
      <ContentBase64>sample string 2</ContentBase64>
      <FileName>sample string 1</FileName>
    </SparePartFileUpload>
    <SparePartFileUpload>
      <ContentBase64>sample string 2</ContentBase64>
      <FileName>sample string 1</FileName>
    </SparePartFileUpload>
  </Documents>
  <GenerateReturnLabel>true</GenerateReturnLabel>
  <GenerateSendLabel>true</GenerateSendLabel>
  <Items>
    <SparePartOrderItem>
      <Qty>2</Qty>
      <ReplacementType>NewPart</ReplacementType>
      <SparePartId>1</SparePartId>
    </SparePartOrderItem>
    <SparePartOrderItem>
      <Qty>2</Qty>
      <ReplacementType>NewPart</ReplacementType>
      <SparePartId>1</SparePartId>
    </SparePartOrderItem>
  </Items>
  <OrderNumber>sample string 6</OrderNumber>
  <OwnerUserId>2</OwnerUserId>
  <Reason>sample string 3</Reason>
  <ReplacementType>NewPart</ReplacementType>
  <ShippingAddressText>sample string 8</ShippingAddressText>
  <StoreId>1</StoreId>
  <UserId>1</UserId>
</CreateSparePartRequestRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.