... {toc} h2. Added trackingLink to ShippingType {code} <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <shippingType ...> ... <trackingLink xlink:href="http://dhl.de?idc={trackingCode}"/> ... </shippingType> {code} h2. Added shippingSupported, externalFulfillmentSupported, trackingLink to ShippingCountry {code} <shippingCountry ...> ... <shippingSupported>true</shippingSupported> <externalFulfillmentSupported>true</externalFulfillmentSupported> <trackingLink xlink:href="http://belgien.de?idc={trackingCode}"/> ... </shippingCountry> {code} h2. Added parcelDelivery to OrderItem shipping Added parcelDelivery link to order item shipping. {code} <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <order ...> ... <orderItems> <orderItem ...> ... <shipping> <parcelDelivery id="200001701"/> </shipping> ... </orderItem> </orderItems> ... </order> {code} h2. Added shipping country and parcel deliveries to Order shipping Added parcelDeliveries attribute to order shipping. {code} <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <order ...> ... <shipping> ... <parcelDeliveries> <parcelDelivery id="200001701"> <parcels> <parcel id="123"> <shippingType id="1"/> <trackingCode>55 55 5</trackingCode> <trackingLink xlink:href="http://post.de?idc=55 55 5"/> <shipped>2012-02-10T00:00:00+01:00</shipped> </parcel> </parcels> </parcelDelivery> </parcelDeliveries> </shipping> ... </order>
|
{code}
|
h2. Added Order Adjustment (TODO)
|
h3. Resources
|
... h4. Adjust Orders || Url | .../v1/orderAdjustments || || Sample | [http://api.spreadshirt.net/api/v1/orderAdjustments|http://api.spreadshirt.net/api/v1/orderAdjustments] || || Type | LIST || || Method | POST || || Special Status Codes | 200 || || APIKey | true || || SessionId | true || Payload: {code} <orderAdjustments> ... </orderAdjustments> {code} h3. Representations h4. OrderAdjustment {code} <orderAdjustments> <orderAdjustment> <order id="123" xlink:href="http://api.spreadshirt.net/api/v1/orders/123"/> <fulfillmentState>CANCELED</fulfillmentState>
|
<orderItemAdjustments> <orderItemAdjustment>
|
<orderItem id="456" xlink:href="http://api.spreadshirt.net/api/v1/orders/123/items/456"/>
|
<fulfillmentState>CANCELED</fulfillmentState> </orderItemAdjustment>
|
... <orderItemAdjustments> </orderAdjustment> </orderAdjustments> {code} h2. Added APIFeatures h3. Resources h4. Retrieve APIFeatures List Returns list of all api features. || Url | .../v1/apiFeatures || || Sample | [http://api.spreadshirt.net/api/v1/apiFeatures] || || Type | LIST || || Method | GET || || Special Status Codes | || || APIKey | true || || SessionId | false || *Response Representation:* {code} <apiFeatures ...> ... </apiFeatures> {code} h4. Retrieve APIFeature Entity || Url | .../v1/apiFeatures/\{apiFeatureId\} || || Sample | [http://api.spreadshirt.net/api/v1/apiFeatures/1] || || Type | ENTITY || || Method | GET || || Special Status Codes | || || APIKey | true || || SessionId | false || *Response Representation:* {code} <apiFeature ...> ... </apiFeature> {code} h3. Representations h4. APIFeature Example: {code} <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <apiFeature xmlns="http://api.spreadshirt.net" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://localhost:8080/api/v1/apiFeatures/1" id="1"> <name>Product Creation</name> <description>Create products.</description> </apiFeature> {code} h2. Added APIKeys h3. Resources h4. Retrieve APIKeys List Returns list of all api keys. || Url | .../v1/apiKeys || || Sample | [http://api.spreadshirt.net/api/v1/apiKeys] || || Type | LIST || || Method | GET || || Special Status Codes | || || APIKey | true (API mgmt feature required) || || SessionId | false || || Query | *\+userId:(xxx)* || *Response Representation:* {code} <apiKeys ...> ... </apiKeys> {code} h4. Retrieve APIKey Entity || Url | .../v1/apiKeys/\{apiKeyId\} || || Sample | [http://api.spreadshirt.net/api/v1/apiKeys/1] || || Type | ENTITY || || Method | GET || || Special Status Codes | || || APIKey | true (API mgmt feature required) || || SessionId | false || *Response Representation:* {code} <apiKey ...> ... </apiKey> {code} h4. Create APIKey Entity || Url | .../v1/apiKeys || || Sample | [http://api.spreadshirt.net/api/v1/apiKeys] || || Type | ENTITY || || Method | POST || || Special Status Codes | || || APIKey | true (API mgmt feature required) || || SessionId | false || *Request Representation:* {code} <apiKey ...> ... </apiKey> {code} *Response:* {code} Location: ... {code} h4. Update APIKey Entity || Url | .../v1/apiKeys/\{apiKeyId\} || || Sample | [http://api.spreadshirt.net/api/v1/apiKeys/1] || || Type | ENTITY || || Method | PUT || || Special Status Codes | || || APIKey | true (API mgmt feature required) || || SessionId | false || *Request Representation:* {code} <apiKey ...> ... </apiKey> {code} h4. Retrieve User APIKeys List Returns list of all api keys for user. || Url | .../v1/users/\{userId\}/apiKeys || || Sample | [http://api.spreadshirt.net/api/v1/users/40000/apiKeys] || || Type | LIST || || Method | GET || || Special Status Codes | || || APIKey | true || || SessionId | true || \*Response Representation:\* {code} <apiKeys ...> ... </apiKeys> {code} h4. Retrieve User APIKey Entity || Url | .../v1/users/\{userId\}/apiKeys/\{apiKeyId\} || || Sample | [http://api.spreadshirt.net/api/v1/users/40000/apiKeys/1] || || Type | ENTITY || || Method | GET || || Special Status Codes | || || APIKey | true || || SessionId | true || *Response Representation:* {code} <apiKey ...> ... </apiKey> {code} h3. Representations h4. APIKey Example: {code} <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <apiKey xmlns="http://api.spreadshirt.net" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://localhost:8080/api/v1/apiKeys/xxx" id="xxx"> <description>This is the api key for xxx</description> <user xlink:href="http://localhost:8080/api/v1/users/40000" id="40000"/> <key>xxx</key> <secret>xxx</secret> <callLimit>5000</callLimit> <apiFeatures> <apiFeature xlink:href="http://localhost:8080/api/v1/apiFeatures/1" id="1"/> <apiFeature xlink:href="http://localhost:8080/api/v1/apiFeatures/3" id="3"/> <apiFeature xlink:href="http://localhost:8080/api/v1/apiFeatures/5" id="5"/> </apiFeatures> <state>ACTIVATED</state> <created>2010-09-17T16:09:07+02:00</created> <modified>2012-02-11T16:14:52+01:00</modified> </apiKey> {code} h2. Added Shop Address h3. Resources h4. Retrieve Shop Address Returns the default shop address. || Url | .../v1/shops/\{shopId\}/address || || Sample | [http://api.spreadshirt.net/api/v1/shops/205909/address] || || Type | ENTITY || || Method | GET || || Special Status Codes | || || APIKey | false || || SessionId | false || *Response Representation:* {code} <address ...> ... </address> {code} h3. Representations h4. Address Example: {code} <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <address xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://api.spreadshirt.net" type="private"> <company>BITBOOST SYSTEMS</company> <person> <firstName>John</firstName> <lastName>Smith</lastName> </person> <street>E DRACHMAN</street> <houseNumber>421</houseNumber> <streetAnnex>Appartment 2</streetAnnex> <city>Los Angeles</city> <state code="CA">California</state> <country code="US"/> <zipCode>85705</zipCode> <email>mbs@spreadshirt.net</email> <phone>+49 341 789 123</phone> <fax>+49 341 789 123</fax> </address> {code} h2. Retrieve ProductType StockState List || Url | .../v1/shops/\{shopId\}/productTypes/\{productTypeId\}/stockStates || || Sample | [http://api.spreadshirt.net/api/v1/shops/205909/productTypes/6/stockStates] || || Type | LIST || || Method | GET || || Special Status Codes | || || APIKey | false || || SessionId | false || \*Response Representation:\* {code} <stockStates ...> ... </stockStates> {code}
|