POST api/v2/orders/submitorder

Transmit order data to Stuller. Response will indicate a success or failure

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CustomerData	Data from the customer.	CustomerData	None.
Contact	Contact informtaion of the customer sending the order.	Contact	None.
Payment	Payment information for the order.	Payment	None.
ShipToAddress	Address to shop to.	ShipToAddress	None.
BillToAddress	The bill to address - the address that the credit card uses.	BillToAddress	None.
Lines	Array of order lines for items.	Collection of Line	None.
Type	The type of order.	string	None.
Version		decimal number	None.
Token		string	None.
Account		string	None.
OrderID		string	None.
PurchaseOrderNumber		string	None.
IfOosType	If type of out of stock the item is.	IfOosType	None.
TestMode		boolean	None.
StoreNumber	The customer store number that the order is submitted for.	string	None.
Instructions	Instructions for the order.	string	None.
PackingSlipPath		string	None.
OrderStatusPostToUrl		string	None.

Sample:

{
  "CustomerData": {
    "OrderNumber": "sample string 1",
    "OrderDate": "2024-12-04T13:12:05.3736284-06:00",
    "EmailConfirmation": {
      "FromAddress": "sample string 1",
      "SendOrderConfirmation": true,
      "SendShipmentConfirmation": true,
      "ToAddress": "sample string 4"
    },
    "ExtraAmount": {
      "Label": "sample string 1",
      "Value": "sample string 2"
    },
    "FreightAmount": 3.1,
    "TaxAmount": 4.1,
    "Message1": "sample string 5",
    "Message2": "sample string 6",
    "AdditionalData": {}
  },
  "Contact": {
    "Name": "sample string 1",
    "Phone": "sample string 2",
    "EmailAddress": "sample string 3"
  },
  "Payment": {
    "Type": "sample string 1"
  },
  "ShipToAddress": {
    "Address": {
      "Name": "sample string 1",
      "AddressLine1": "sample string 2",
      "AddressLine2": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "PostalCode": "sample string 6",
      "Province": "sample string 7",
      "Country": "sample string 8",
      "Phone": "sample string 9"
    },
    "ShipComplete": true,
    "ShipMethodType": "UPS_NEXT_DAY",
    "RemovePricing": true,
    "SignatureRequired": true
  },
  "BillToAddress": {
    "Address": {
      "Name": "sample string 1",
      "AddressLine1": "sample string 2",
      "AddressLine2": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "PostalCode": "sample string 6",
      "Province": "sample string 7",
      "Country": "sample string 8",
      "Phone": "sample string 9"
    },
    "SameAsShipTo": true
  },
  "Lines": [
    {
      "Items": [
        {
          "Clasp": {
            "Number": "sample string 1"
          },
          "Stones": [
            {
              "Location": 1,
              "Number": "sample string 2",
              "SerialNumber": "sample string 3",
              "IsCustomerStone": true,
              "CustomerStoneValue": 5.0
            },
            {
              "Location": 1,
              "Number": "sample string 2",
              "SerialNumber": "sample string 3",
              "IsCustomerStone": true,
              "CustomerStoneValue": 5.0
            }
          ],
          "Engravings": [
            {
              "EngravingLine": [
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                },
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                }
              ],
              "Location": 1,
              "EngravingType": "sample string 2",
              "FontType": "sample string 3",
              "FontSize": "sample string 4",
              "FillOption": "sample string 5",
              "FillColor": "sample string 6",
              "SpecialFinish": "sample string 7"
            },
            {
              "EngravingLine": [
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                },
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                }
              ],
              "Location": 1,
              "EngravingType": "sample string 2",
              "FontType": "sample string 3",
              "FontSize": "sample string 4",
              "FillOption": "sample string 5",
              "FillColor": "sample string 6",
              "SpecialFinish": "sample string 7"
            }
          ],
          "EarringBack": {
            "Number": "sample string 1"
          },
          "Chain": {
            "Number": "sample string 1"
          },
          "Notes": [
            {
              "NoteType": "Manufacturing",
              "Text": "sample string 1"
            },
            {
              "NoteType": "Manufacturing",
              "Text": "sample string 1"
            }
          ],
          "Number": "sample string 1",
          "RingSize": 2.0,
          "ChainLength": 4,
          "Instructions": "sample string 6",
          "AdditionalDescription": "sample string 7",
          "RequestedShipDate": "sample string 8"
        },
        {
          "Clasp": {
            "Number": "sample string 1"
          },
          "Stones": [
            {
              "Location": 1,
              "Number": "sample string 2",
              "SerialNumber": "sample string 3",
              "IsCustomerStone": true,
              "CustomerStoneValue": 5.0
            },
            {
              "Location": 1,
              "Number": "sample string 2",
              "SerialNumber": "sample string 3",
              "IsCustomerStone": true,
              "CustomerStoneValue": 5.0
            }
          ],
          "Engravings": [
            {
              "EngravingLine": [
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                },
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                }
              ],
              "Location": 1,
              "EngravingType": "sample string 2",
              "FontType": "sample string 3",
              "FontSize": "sample string 4",
              "FillOption": "sample string 5",
              "FillColor": "sample string 6",
              "SpecialFinish": "sample string 7"
            },
            {
              "EngravingLine": [
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                },
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                }
              ],
              "Location": 1,
              "EngravingType": "sample string 2",
              "FontType": "sample string 3",
              "FontSize": "sample string 4",
              "FillOption": "sample string 5",
              "FillColor": "sample string 6",
              "SpecialFinish": "sample string 7"
            }
          ],
          "EarringBack": {
            "Number": "sample string 1"
          },
          "Chain": {
            "Number": "sample string 1"
          },
          "Notes": [
            {
              "NoteType": "Manufacturing",
              "Text": "sample string 1"
            },
            {
              "NoteType": "Manufacturing",
              "Text": "sample string 1"
            }
          ],
          "Number": "sample string 1",
          "RingSize": 2.0,
          "ChainLength": 4,
          "Instructions": "sample string 6",
          "AdditionalDescription": "sample string 7",
          "RequestedShipDate": "sample string 8"
        }
      ],
      "Serial": {
        "Instructions": "sample string 1",
        "Value": "sample string 2"
      },
      "Quantity": 1,
      "ExtendedPrice": 2.0,
      "Item": "sample string 3",
      "Description": "sample string 4",
      "BoxType": "Black",
      "GiftWrap": true,
      "BoxDescription": "sample string 7",
      "Message": "sample string 8",
      "LineNumber": "sample string 9",
      "Source": "sample string 10",
      "CustomerLineReference": "sample string 11"
    },
    {
      "Items": [
        {
          "Clasp": {
            "Number": "sample string 1"
          },
          "Stones": [
            {
              "Location": 1,
              "Number": "sample string 2",
              "SerialNumber": "sample string 3",
              "IsCustomerStone": true,
              "CustomerStoneValue": 5.0
            },
            {
              "Location": 1,
              "Number": "sample string 2",
              "SerialNumber": "sample string 3",
              "IsCustomerStone": true,
              "CustomerStoneValue": 5.0
            }
          ],
          "Engravings": [
            {
              "EngravingLine": [
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                },
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                }
              ],
              "Location": 1,
              "EngravingType": "sample string 2",
              "FontType": "sample string 3",
              "FontSize": "sample string 4",
              "FillOption": "sample string 5",
              "FillColor": "sample string 6",
              "SpecialFinish": "sample string 7"
            },
            {
              "EngravingLine": [
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                },
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                }
              ],
              "Location": 1,
              "EngravingType": "sample string 2",
              "FontType": "sample string 3",
              "FontSize": "sample string 4",
              "FillOption": "sample string 5",
              "FillColor": "sample string 6",
              "SpecialFinish": "sample string 7"
            }
          ],
          "EarringBack": {
            "Number": "sample string 1"
          },
          "Chain": {
            "Number": "sample string 1"
          },
          "Notes": [
            {
              "NoteType": "Manufacturing",
              "Text": "sample string 1"
            },
            {
              "NoteType": "Manufacturing",
              "Text": "sample string 1"
            }
          ],
          "Number": "sample string 1",
          "RingSize": 2.0,
          "ChainLength": 4,
          "Instructions": "sample string 6",
          "AdditionalDescription": "sample string 7",
          "RequestedShipDate": "sample string 8"
        },
        {
          "Clasp": {
            "Number": "sample string 1"
          },
          "Stones": [
            {
              "Location": 1,
              "Number": "sample string 2",
              "SerialNumber": "sample string 3",
              "IsCustomerStone": true,
              "CustomerStoneValue": 5.0
            },
            {
              "Location": 1,
              "Number": "sample string 2",
              "SerialNumber": "sample string 3",
              "IsCustomerStone": true,
              "CustomerStoneValue": 5.0
            }
          ],
          "Engravings": [
            {
              "EngravingLine": [
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                },
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                }
              ],
              "Location": 1,
              "EngravingType": "sample string 2",
              "FontType": "sample string 3",
              "FontSize": "sample string 4",
              "FillOption": "sample string 5",
              "FillColor": "sample string 6",
              "SpecialFinish": "sample string 7"
            },
            {
              "EngravingLine": [
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                },
                {
                  "LineLocation": 1,
                  "Text": "sample string 2"
                }
              ],
              "Location": 1,
              "EngravingType": "sample string 2",
              "FontType": "sample string 3",
              "FontSize": "sample string 4",
              "FillOption": "sample string 5",
              "FillColor": "sample string 6",
              "SpecialFinish": "sample string 7"
            }
          ],
          "EarringBack": {
            "Number": "sample string 1"
          },
          "Chain": {
            "Number": "sample string 1"
          },
          "Notes": [
            {
              "NoteType": "Manufacturing",
              "Text": "sample string 1"
            },
            {
              "NoteType": "Manufacturing",
              "Text": "sample string 1"
            }
          ],
          "Number": "sample string 1",
          "RingSize": 2.0,
          "ChainLength": 4,
          "Instructions": "sample string 6",
          "AdditionalDescription": "sample string 7",
          "RequestedShipDate": "sample string 8"
        }
      ],
      "Serial": {
        "Instructions": "sample string 1",
        "Value": "sample string 2"
      },
      "Quantity": 1,
      "ExtendedPrice": 2.0,
      "Item": "sample string 3",
      "Description": "sample string 4",
      "BoxType": "Black",
      "GiftWrap": true,
      "BoxDescription": "sample string 7",
      "Message": "sample string 8",
      "LineNumber": "sample string 9",
      "Source": "sample string 10",
      "CustomerLineReference": "sample string 11"
    }
  ],
  "Type": "sample string 1",
  "Version": 2.0,
  "Token": "sample string 3",
  "Account": "sample string 4",
  "OrderID": "sample string 5",
  "PurchaseOrderNumber": "sample string 6",
  "IfOosType": "Backorder",
  "TestMode": true,
  "StoreNumber": "sample string 8",
  "Instructions": "sample string 9",
  "PackingSlipPath": "sample string 10",
  "OrderStatusPostToUrl": "sample string 11"
}

Sample:

Sample not available.

Sample:

Sample not available.

Response Information

Resource Description

OrderResponse

Name	Description	Type	Additional information
ConfirmationNumber	The order confirmation number. If nothing is returned there was an error in the order.	integer	None.
Created	When the order was created.	boolean	None.
Errors	List of errors when submitting the order.	Collection of Error	None.

Response Formats

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

Sample:

{
  "ConfirmationNumber": 1,
  "Created": true,
  "Errors": [
    {
      "Message": "sample string 1"
    },
    {
      "Message": "sample string 1"
    }
  ]
}

Sample:

<OrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ConfirmationNumber>1</ConfirmationNumber>
  <Created>true</Created>
  <Errors>
    <Error>
      <Message>sample string 1</Message>
    </Error>
    <Error>
      <Message>sample string 1</Message>
    </Error>
  </Errors>
</OrderResponse>