Navigation¶

• API Solution
  

• General
• Header
  

• Action
• Address
• Affiliate Marketing
• Article
• Customer
• Contacting
• ContactingSetting
• Edit Image
• Language
• Order
• Payment
• Portal
• Price
• PrintData
• Shipment
• ShipmentTariff
• Resale Unit
• Time Zone
• Translation
  

• All Pages
  

Search Web2Print Wiki
»

• Create a new Page
• Categories
• Administration
• File Management
  

• Create Account 
  mass customization api for brochures, t-shirts, posters, photobooks, business cards, photo products, wallpapers, shoes, sticker, surfboards and much more
    
  

Order

1 Table of Contents¶

Table of Contents [Hide/Show] 1 Table of Contents 2 Overview 3 Elements    3.1 Additional response elements 4 Example 5 Placed order    5.1 Endpoints       5.1.1 Get existing order       5.1.2 List customer's orders

2 Overview¶

The order object features two different models. The first one features a lightweight object model to place an order. After the order is placed a more complex and feature rich object model is available, to support all the features the API offers.

3 Elements¶

Name	Type	Datatype	Example	Default	Description
Article	required	list of elements	-	-	The associated Article elements.
Customer	req./opt.	element	-	-	The associated Customer element. Required when placing order call.
Shipment	required	element	-	-	Shipment configuration element. Required to calculate shipping cost for the calculation call and placing the actual order. For shipping cost calculation only the Country element is required inside the ShipTo element.
Billing	optional	element	-	-	Billingaddress element. Optional and used for varying billing address.
ResaleUnitId	optional	guid	-	-	Optional ResaleUnit Guid field, that identifies the selling location of the current order. Required when multiple ResaleUnits are defined and in use.

3.1 Additional response elements¶

Name	Type	Datatype	Example	Default	Description
InternalOrderNumber	required	string	-	-	Internal unique order number, generated by the system during an order call.

4 Example¶

XML:

<Order>  
  <Article>
    <Id>1561</Id>
    <PageLengthOpen>11.69</PageLengthOpen>
    <PageWidthOpen>16.54</PageWidthOpen>
    <PageOrientation>Portrait</PageOrientation>
    <PrintingMethod>OneOff</PrintingMethod>      
    <FabricationType>Plot</FabricationType>
    <NumberColorsFront>4</NumberColorsFront>
    <NumberColorsBack>0</NumberColorsBack>
    <Amount>1</Amount>
    <Run>100</Run>
    <Payment>
      <Type>CIA</Type>
    </Payment>
    <IdMaterial>53</IdMaterial>
  </Article>
  <Shipment>
    <ShipTo>
      <Country>US</Country>
    </ShipTo>
  </Shipment>
</Order>

JSON:

"Order": {
  "Article": {
    "Id": 1561,
    "Amount": 1,
    "Run": 100,
    "PageLengthOpen": 11.69,
    "PageWidthOpen": 16.54,
    "PrintingMethod": "OneOff",
    "FabricationType": "Plot",
    "NumberColorsFront": 4,
    "NumberColorsBack": 0,
    "PageOrientation": "Portrait",
    "Payment": {
      "Type": "CIA"
    },
    "IdMaterial": 53
  },
  "Shipment": {
    "ShipTo": {
      "Country": "US",
    }
  }
}

5 Placed order¶

When an order has been placed it's being transformed into a more complex and fine grained structure.

5.1 Endpoints¶

5.1.1 Get existing order¶

To get a placed order by its OrderNumber the following endpoint can be used.

5.1.2 List customer's orders¶

To get a list of all placed order by a specific customer the following endpoint can be used. The result will be paged so you can use the PageSize parameter to define how many items there will be in one page and PageIndex to set the current page. The response will also contain the overall count of orders.

____________

Discussions about Web2Print SaaS Cloud API JSON REST XML:

{discussion}