Payment Services

GET /user/{userId}/products

Requires authentication with server or user access token.

List products the user has access to.

Request

GET /api/2/user/{userId}/products

userId

required path parameter

The user's uuid or userId (not to be mistaken with the deprecated id).

filters

optional
all
Include all items in the response, including deleted/blocked or otherwise excluded items
none
Do not apply any status filters (e.g. same as 'all')
active
Filter by items with status active
expired
Return all items with status expired

Example request

cURL
curl https://login.schibsted.com/api/2/user/42/products -G \
   -d "oauth_token=[access token]"
Java
SpidOAuthToken token = spidClient.getUserToken(code);
String responseJSON = spidClient.
    GET(token, "/user/42/products").
    getResponseBody();

This example is an excerpt, see a full example

PHP
<?php
$client->auth();
echo var_dump($client->api("/user/42/products"));

This example is an excerpt, see a full example

Clojure
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-user-token client "[code]")]
  (spid/GET client token "/user/42/products"))

Response

This endpoint supports the JSON and JSON-P response formats.

Success: 200 OK

Returns a collection of Digital contents, as an object with productId for property names, and Digital contents for values.

Digital content

userProductId

integer (as string)

productId

integer (as string)

parentProductId

integer (as string)

clientId

string

userId

integer (as string)

orderId

integer (as string)

status

integer (as string)

count

integer (as string)

updated

datetime

When the digital content was last updated

created

datetime

When the digital content was created

bundleId

integer (as string)

statusMsg

string

The check mark indicates that the field always contains a valid non-empty value.

Failure cases

Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.

  • 401 Unauthorized You don't have administration rights for this client.
  • 401 Unauthorized Your client doesn't have administration rights for this client.
  • 403 Forbidden Client is not authorized to access this API endpoint. Contact SPiD to request access.
  • 403 Forbidden Requesting IP is not whitelisted
  • 403 Forbidden Access token rejected
  • 404 Not Found Unknown client ID
  • 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
  • 420 Request Ratelimit exceeded

Sample response

JSON
{
    "10111": {
        "userProductId": "3",
        "productId": "10111",
        "parentProductId": "10111",
        "clientId": "4e8463569caf7ca019000007",
        "userId": "100003",
        "orderId": "674",
        "status": "3",
        "count": "9",
        "updated": "2013-08-27 18:21:55",
        "created": "2013-05-08 09:22:06",
        "bundleId": "0",
        "statusMsg": "Available"
    },
    "10117": {
        "userProductId": "19",
        "productId": "10117",
        "parentProductId": "10117",
        "clientId": "4e8463569caf7ca019000007",
        "userId": "100003",
        "orderId": "0",
        "status": "3",
        "count": "1",
        "updated": "2013-08-01 15:44:01",
        "created": "2013-08-01 15:42:42",
        "bundleId": "0",
        "statusMsg": "Available"
    }
}
JSON-P
json({
    "10111": {
        "userProductId": "3",
        "productId": "10111",
        "parentProductId": "10111",
        "clientId": "4e8463569caf7ca019000007",
        "userId": "100003",
        "orderId": "674",
        "status": "3",
        "count": "9",
        "updated": "2013-08-27 18:21:55",
        "created": "2013-05-08 09:22:06",
        "bundleId": "0",
        "statusMsg": "Available"
    },
    "10117": {
        "userProductId": "19",
        "productId": "10117",
        "parentProductId": "10117",
        "clientId": "4e8463569caf7ca019000007",
        "userId": "100003",
        "orderId": "0",
        "status": "3",
        "count": "1",
        "updated": "2013-08-01 15:44:01",
        "created": "2013-08-01 15:42:42",
        "bundleId": "0",
        "statusMsg": "Available"
    }
});

Comments/feedback

Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.