Order API Released

A couple of days ago, we released our new order API. The order API allows partners to

  • implement their own checkout,
  • handle customer payments and interactions themselves and
  • use Spreadshirt as white-label fulfiller only.

That means for Spreadshirt, that we

  • receive orders from the partner,
  • produce the order items on the partner’s account and
  • deliver the produced order items to the partner’s customers.

The partner handles all customer interactions, starting from customer payments to handling customer questions to sending e-mails on delivery of order items. In order to use the order API, the partner has to sign a contract with Spreadshirt, that makes sure that we are allowed to produce the order items on the partner’s account. The partner has to pay a monthly invoice for all produced order items.
In general, the order API is thought for partners that generate a relevant number of orders per year, e.g. more than 2000 orders. Please contact Spreadshirt sales team (sales(at)spreadshirt(dot)net) for contract infos and further information on the order API.

The new order API basically provides the following new features:

  • Submit Order: Submit order basically allows the partner to submit a new order with one or more order items to Spreadshirt.
    The API resource added therefore is /api/v1/orders. One can submit the order by conducting a HTTP POST request on this resource.
  • Retrieve Order List: One can also retrieve a list of all submitted orders and filter these orders by different criteria.
    The API resource that can be used therefore is also …/api/v1/orders. The list of orders can be retrieved by conducting a HTTP GET request on this resource.
  • Retrieve Single Order: It is also possible to retrieve single orders from the API. The API resource added therefore is …/api/v1/orders/{orderId}. One can retrieve the order by providing the right orderId and conducting a HTTP GET request on the resource.

During order processing, the fulfillment state of single order items will change, because order items get produced, get canceled or get shipped. In order to allow partners to better track the changes of order item fulfillment states, we generate so called order reports.
An order report contains all fulfillment state changes on order items of the partner for a specific period. In order to work with these order reports, we added the following features to the API:

  • Retrieve Order Report List: One can retrieve a list of all generated order reports and filter these order reports by different criteria. Therefore, we added the new API resource …/api/v1/orderReports. One can retrieve the order reports by conducting a HTTP GET request on the resource.
  • Retrieve Order Report: It is also possible to retrieve a single order report. The API resource added therefore is …/api/v1/orderReports/{orderReportId}. One can retrieve an order report by providing the right orderReportId and conducting a HTTP GET request on the resource.

You can find more details about the order API on our developer wiki.