POST v2/Order

Request Information

URI Parameters

None.

Body Parameters

ApiOrder
NameDescriptionTypeAdditional information
AdditionalInstructions

Collection of string

None.

CampaignNumber

string

None.

CustomerOrderNumber

string

None.

OrderContact

SignZone.Enterprise.Models.PublicApi.Contact

None.

OrderItems

Collection of ApiOrderItem

Required

PaymentConfirmation

string

None.

PaymentTerms

string

None.

PaymentType

SignZone.Enterprise.Models.PublicApi.PaymentTypes

None.

PoDate

date

None.

PoNumber

string

None.

PromotionCode

string

None.

ProofEmail

string

None.

ReferencePaymentConfirmation

string

None.

RequestedInHand

date

None.

RequestedShipDate

date

None.

ShipToAddress

SignZone.Enterprise.Models.PublicApi.Address

None.

ShipToIdentificationCode

string

None.

SignZoneCustomerNumber

string

Required

ThirdPartyShippingAccount

string

None.

TestOnly

boolean

None.

ShippingCarrier

string

None.

ShippingMethod

string

None.

CustomLabelLink

string

None.

ShippingInstructions

string

None.

CaseId

string

None.

Workgroup

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",
      "LineNumber": "sample string 5",
      "ParentLineNumber": "sample string 6",
      "CustomerLineNumber": "sample string 7",
      "CustomerLineReference": "sample string 8",
      "Uom": "sample string 9",
      "Description": "sample string 10",
      "UnitPrice": 1.0,
      "ArtWorkLink": "sample string 11",
      "CustomerInstructions": "sample string 12",
      "ImprintLocationCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "FinishingTypeCode": "sample string 13",
      "ReferencePo": "sample string 14"
    },
    {
      "Sku": "sample string 1",
      "Quantity": 2.0,
      "VariantCode": "sample string 3",
      "SecondaryVariantCode": "sample string 4",
      "LineNumber": "sample string 5",
      "ParentLineNumber": "sample string 6",
      "CustomerLineNumber": "sample string 7",
      "CustomerLineReference": "sample string 8",
      "Uom": "sample string 9",
      "Description": "sample string 10",
      "UnitPrice": 1.0,
      "ArtWorkLink": "sample string 11",
      "CustomerInstructions": "sample string 12",
      "ImprintLocationCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "FinishingTypeCode": "sample string 13",
      "ReferencePo": "sample string 14"
    }
  ],
  "PaymentConfirmation": "sample string 3",
  "PaymentTerms": "sample string 4",
  "PaymentType": "Blank",
  "PoDate": "2026-02-03T08:04:10.2738303-06:00",
  "PoNumber": "sample string 5",
  "PromotionCode": "sample string 6",
  "ProofEmail": "sample string 7",
  "ReferencePaymentConfirmation": "sample string 8",
  "RequestedInHand": "2026-02-03T08:04:10.2738303-06:00",
  "RequestedShipDate": "2026-02-03T08:04:10.2738303-06:00",
  "ShipToAddress": {
    "CompanyName": "sample string 1",
    "StreetAddress1": "sample string 2",
    "StreetAddress2": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6",
    "Country": "sample string 7",
    "Contact": "sample string 8"
  },
  "ShipToIdentificationCode": "sample string 9",
  "SignZoneCustomerNumber": "sample string 10",
  "ThirdPartyShippingAccount": "sample string 11",
  "TestOnly": true,
  "ShippingCarrier": "sample string 12",
  "ShippingMethod": "sample string 13",
  "CustomLabelLink": "sample string 14",
  "ShippingInstructions": "sample string 15",
  "CaseId": "sample string 16",
  "Workgroup": "sample string 17"
}

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>
  <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>
      <LineNumber>sample string 5</LineNumber>
      <ParentLineNumber>sample string 6</ParentLineNumber>
      <CustomerLineNumber>sample string 7</CustomerLineNumber>
      <CustomerLineReference>sample string 8</CustomerLineReference>
      <Uom>sample string 9</Uom>
      <Description>sample string 10</Description>
      <UnitPrice>1</UnitPrice>
      <ArtWorkLink>sample string 11</ArtWorkLink>
      <CustomerInstructions>sample string 12</CustomerInstructions>
      <ImprintLocationCodes>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </ImprintLocationCodes>
      <FinishingTypeCode>sample string 13</FinishingTypeCode>
      <ReferencePo>sample string 14</ReferencePo>
    </OrderItem>
    <OrderItem>
      <Sku>sample string 1</Sku>
      <Quantity>2</Quantity>
      <VariantCode>sample string 3</VariantCode>
      <SecondaryVariantCode>sample string 4</SecondaryVariantCode>
      <LineNumber>sample string 5</LineNumber>
      <ParentLineNumber>sample string 6</ParentLineNumber>
      <CustomerLineNumber>sample string 7</CustomerLineNumber>
      <CustomerLineReference>sample string 8</CustomerLineReference>
      <Uom>sample string 9</Uom>
      <Description>sample string 10</Description>
      <UnitPrice>1</UnitPrice>
      <ArtWorkLink>sample string 11</ArtWorkLink>
      <CustomerInstructions>sample string 12</CustomerInstructions>
      <ImprintLocationCodes>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </ImprintLocationCodes>
      <FinishingTypeCode>sample string 13</FinishingTypeCode>
      <ReferencePo>sample string 14</ReferencePo>
    </OrderItem>
  </OrderItems>
  <PaymentTerms>sample string 4</PaymentTerms>
  <PaymentType>Blank</PaymentType>
  <PoNumber>sample string 5</PoNumber>
  <PromotionCode>sample string 6</PromotionCode>
  <ProofEmail>sample string 7</ProofEmail>
  <RequestedInHand>2026-02-03T08:04:10.2738303-06:00</RequestedInHand>
  <RequestedShipDate>2026-02-03T08:04:10.2738303-06:00</RequestedShipDate>
  <ShipToAddress>
    <CompanyName>sample string 1</CompanyName>
    <StreetAddress1>sample string 2</StreetAddress1>
    <StreetAddress2>sample string 3</StreetAddress2>
    <City>sample string 4</City>
    <State>sample string 5</State>
    <Zip>sample string 6</Zip>
    <Country>sample string 7</Country>
    <Contact>sample string 8</Contact>
  </ShipToAddress>
  <ShipToIdentificationCode>sample string 9</ShipToIdentificationCode>
  <SignZoneCustomerNumber>sample string 10</SignZoneCustomerNumber>
  <ThirdPartyShippingAccount>sample string 11</ThirdPartyShippingAccount>
  <TestOnly>true</TestOnly>
  <ShippingCarrier>sample string 12</ShippingCarrier>
  <ShippingMethod>sample string 13</ShippingMethod>
  <CustomLabelLink>sample string 14</CustomLabelLink>
  <ShippingInstructions>sample string 15</ShippingInstructions>
  <CaseId>sample string 16</CaseId>
  <Workgroup>sample string 17</Workgroup>
</Order>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.