Order

All endpoints relating to an Order

New Order

POST https://wowflow.wowbooks.com/api/import

This endpoint is used to submit an order.

Headers

Name	Type	Description
Authorization	string	Bearer token provided by Login endpoint

Request Body

Name	Type	Description
customerRef	string	Your order reference
shippingMethod	string	Requested Shipping method (options will be confirmed upon integration onboarding).
sender	object	Sender details for shipment
sender.taxNumber	string	The Tax number of the sender. Used for International shipments outside the UK (e.g. EORI Number)
sender.firstName	string	The Senders First Name
sender.lastName	string	The Senders Last Name
sender.addressLine1	string	The Senders Address Line
sender.addressLine2	string	The Senders Address Line
sender.addressLine3	string	The Senders Address Line
sender.town	string	The Senders Town
sender.county	string	The Senders County
sender.postcode	string	The Senders Postcode
sender.telephone	string	The Senders Telephone
sender.email	string	The Senders Email
sender.isoCountryCode	string	The Senders Country code, in ISO format
delivery	object	Delivery details object.
delivery.firstname	string	Delivery First Name
delivery.lastName	string	Delivery Last Name
delivery.addressLine1	string	Delivery Address Line
delivery.addressLine2	string	Delivery Address Line
delivery.addressLine3	string	Delivery Address Line
delivery.town	string	Delivery Town
delivery.county	string	Delivery County
delivery.postCode	string	Delivery PostCode
delivery.country	string	Delivery Country
delivery.isoCountryCode	string	Delivery Country, in ISO Format
delivery.reference	string	Delivery reference.
delivery.dutyTaxNumber	string	Used in conjuction with dutyTaxNumberType field.
delivery.dutyTaxNumberType	string	Used in conjuction with dutyTaxNumber field, should be a value of ABN, IOSS, IRD, OSS or VOEC.
delivery.value	string	Import Tax Order Value.
delivery.value	string	Import Tax Order Value.
delivery.shippingPrice	string	Import Tax Shipping Price.
delivery.currencyCode	string	Import Tax currency code. e.g. GBP.
jobs	array	Array of Job objects within the order.
jobs[i].productCode	string	Product Code /(this will be supplied on integration)
jobs[i].qty	number	Quantity of the job
jobs[i].pageCount	number	Total number of pages of the item
jobs[i].files	array	Asset files array for the item
jobs[i].files[i].cover	string	URL to the artwork for the Cover element.
jobs[i].files[i].text	string	URL to the artwork for the Text / Content element.
jobs[i].value	number	Tax Value for the Job /(normally the sale price to the end customer).
jobs[i].customText1	string	Any additional data to be passed.
jobs[i].customText2	string	Any additional data to be passed.
jobs[i].customText3	string	Any additional data to be passed.
jobs[i].isSplitJob	boolean	This is set to true if each book needs to be tracked independently throughout production.

200 Order successfully retrieved.

{
    "message": "Success",
    "orderId": {{orderId}}
}

Remember to include the 'Bearer' in the header value followed by your token.

Authorization Header

'Authorization': 'Bearer '

Minimum

Order Example

{
    "customerRef": "{{$randomAlphaNumeric}}",
    "shippingMethod": "standard",
    "delivery": {
        "firstName": "Test",
        "lastName": "Order",
        "addressLine1": "Sample House",
        "addressLine2": "Sample Street",
        "addressLine3": "",
        "town": "Sample Town",
        "county": "Sampleshire",
        "postCode": "AB1 2CD",
        "country": "United Kingdom",
        "isoCountryCode": "GB",
        "reference": "{{$randomAlphaNumeric}}",
    },
    "jobs": [
        {
            "productCode": "{{productCode}}",
            "jobReference": "ABCD1234",
            "qty": 1,
            "pageCount": 20,
            "files": [
                {
                    "cover": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
                    "text": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
                }
            ],
            "value": 10.00
        }
    ]
}

Full

put

Path parameters

idinteger · int32Required

Responses

200

Success

put

/api/Order/cancel/{id}

HTTPcURLJavaScriptPython

PUT /api/Order/cancel/{id} HTTP/1.1
Host: 
Accept: */*

200

Success

No content

post

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

orderIdinteger · int32Optional

clientOrderReferencestringOptional

isReworkJobbooleanRead-onlyOptional

Responses

200

Success

post

/api/Order/reprint

HTTPcURLJavaScriptPython

POST /api/Order/reprint HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 151

{
  "orderId": 1,
  "clientOrderReference": "text",
  "jobs": [
    {
      "jobId": 1,
      "clientJobReference": "text",
      "reworkQuantity": 1,
      "reworkOptionId": 1,
      "artworkType": "text"
    }
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

Success

No content