POST v1/Order

Request Information

URI Parameters

None.

Body Parameters

OrderOfOrderItem
NameDescriptionTypeAdditional information
AdditionalInstructions

Any additional Order specific instructions.

Collection of string

None.

CampaignNumber

Campaign Number.

string

None.

CustomerOrderNumber

Customer Order Number for reference.

string

None.

OrderContact

Order Contact information. The person who should be contacted if there are questions regarding the order.

Contact

None.

OrderItems

List of Items ordered.

Collection of OrderItem

Required

PaymentConfirmation

Gets or sets the payment confirmation.

string

None.

PaymentTerms

Payment Terms.

string

None.

PaymentType

gets or sets the PaymentType

PaymentTypes

None.

PoDate

Date PO Was Created.

date

None.

PoNumber

Purchase Order Number.

string

None.

PromotionCode

Promotion Code.

string

None.

ProofEmail

Artwork approval email.

string

None.

ReferencePaymentConfirmation

Reference payment confirmation.

string

None.

ReferencePo

Artwork PO Reference. If this order requires artwork submitted in a previous order use this field to Reference the PO that contained the artwork.

string

None.

RequestedInHand

Requested In Hands Date.

date

None.

RequestedShipDate

Requested Ship Date.

date

None.

ShipToAddress

Ship To Address.

Address

None.

ShipToIdentificationCode

An Identification Code for the ship to address. Will be passed on to the Invoice.

string

None.

SignZoneCustomerNumber

Customer Number Assigned by SignZone.

string

Required

ThirdPartyShippingAccount

3rd party shipping account number.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "AdditionalInstructions": [
    "sample string 1",
    "sample string 2"
  ],
  "CampaignNumber": "sample string 1",
  "CustomerOrderNumber": "sample string 2",
  "OrderContact": {
    "Name": "sample string 1",
    "PhoneNumber": "sample string 2",
    "Email": "sample string 3"
  },
  "OrderItems": [
    {
      "Sku": "sample string 1",
      "Quantity": 2.0,
      "VariantCode": "sample string 3",
      "SecondaryVariantCode": "sample string 4",
      "CustomerLineNumber": "sample string 5",
      "CustomerLineReference": "sample string 6",
      "ParentItemId": 1,
      "Uom": "sample string 7",
      "Description": "sample string 8",
      "UnitPrice": 1.0
    },
    {
      "Sku": "sample string 1",
      "Quantity": 2.0,
      "VariantCode": "sample string 3",
      "SecondaryVariantCode": "sample string 4",
      "CustomerLineNumber": "sample string 5",
      "CustomerLineReference": "sample string 6",
      "ParentItemId": 1,
      "Uom": "sample string 7",
      "Description": "sample string 8",
      "UnitPrice": 1.0
    }
  ],
  "PaymentConfirmation": "sample string 4",
  "PaymentTerms": "sample string 5",
  "PaymentType": 0,
  "PoDate": "2019-10-21T09:57:15.6945676-05:00",
  "PoNumber": "sample string 6",
  "PromotionCode": "sample string 7",
  "ProofEmail": "sample string 8",
  "ReferencePaymentConfirmation": "sample string 9",
  "ReferencePo": "sample string 10",
  "RequestedInHand": "2019-10-21T09:57:15.6945676-05:00",
  "RequestedShipDate": "2019-10-21T09:57:15.6945676-05:00",
  "ShipToAddress": {
    "CompanyName": "sample string 1",
    "CompanyName2": "sample string 2",
    "AddressType": 0,
    "StreetAddress1": "sample string 3",
    "StreetAddress2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7",
    "Country": "sample string 8",
    "Contact": "sample string 9"
  },
  "ShipToIdentificationCode": "sample string 11",
  "SignZoneCustomerNumber": "sample string 12",
  "ThirdPartyShippingAccount": "sample string 13"
}

application/xml, text/xml

Sample:
<Order xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AdditionalInstructions>
    <AdditionalInstruction>sample string 1</AdditionalInstruction>
    <AdditionalInstruction>sample string 2</AdditionalInstruction>
  </AdditionalInstructions>
  <CampaignNumber>sample string 1</CampaignNumber>
  <CustomerOrderNumber>sample string 2</CustomerOrderNumber>
  <CustomerServiceRep>sample string 3</CustomerServiceRep>
  <OrderContact>
    <Name>sample string 1</Name>
    <PhoneNumber>sample string 2</PhoneNumber>
    <Email>sample string 3</Email>
  </OrderContact>
  <OrderItems>
    <OrderItem>
      <Sku>sample string 1</Sku>
      <Quantity>2</Quantity>
      <VariantCode>sample string 3</VariantCode>
      <SecondaryVariantCode>sample string 4</SecondaryVariantCode>
      <CustomerLineNumber>sample string 5</CustomerLineNumber>
      <CustomerLineReference>sample string 6</CustomerLineReference>
      <ParentItemId>1</ParentItemId>
      <Uom>sample string 7</Uom>
      <Description>sample string 8</Description>
      <UnitPrice>1</UnitPrice>
    </OrderItem>
    <OrderItem>
      <Sku>sample string 1</Sku>
      <Quantity>2</Quantity>
      <VariantCode>sample string 3</VariantCode>
      <SecondaryVariantCode>sample string 4</SecondaryVariantCode>
      <CustomerLineNumber>sample string 5</CustomerLineNumber>
      <CustomerLineReference>sample string 6</CustomerLineReference>
      <ParentItemId>1</ParentItemId>
      <Uom>sample string 7</Uom>
      <Description>sample string 8</Description>
      <UnitPrice>1</UnitPrice>
    </OrderItem>
  </OrderItems>
  <PaymentConfirmation>sample string 4</PaymentConfirmation>
  <PaymentTerms>sample string 5</PaymentTerms>
  <PaymentType>Blank</PaymentType>
  <PoDate>2019-10-21T09:57:15.6945676-05:00</PoDate>
  <PoNumber>sample string 6</PoNumber>
  <PromotionCode>sample string 7</PromotionCode>
  <ProofEmail>sample string 8</ProofEmail>
  <ReferencePaymentConfirmation>sample string 9</ReferencePaymentConfirmation>
  <ReferencePo>sample string 10</ReferencePo>
  <RequestedInHand>2019-10-21T09:57:15.6945676-05:00</RequestedInHand>
  <RequestedShipDate>2019-10-21T09:57:15.6945676-05:00</RequestedShipDate>
  <ShipToAddress>
    <CompanyName>sample string 1</CompanyName>
    <CompanyName2>sample string 2</CompanyName2>
    <AddressType>None</AddressType>
    <StreetAddress1>sample string 3</StreetAddress1>
    <StreetAddress2>sample string 4</StreetAddress2>
    <City>sample string 5</City>
    <State>sample string 6</State>
    <Zip>sample string 7</Zip>
    <Country>sample string 8</Country>
    <Contact>sample string 9</Contact>
  </ShipToAddress>
  <ShipToIdentificationCode>sample string 11</ShipToIdentificationCode>
  <SignZoneCustomerNumber>sample string 12</SignZoneCustomerNumber>
  <ThirdPartyShippingAccount>sample string 13</ThirdPartyShippingAccount>
</Order>

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.