{
  "opencollection": "1.0.0",
  "info": {
    "name": "Withings developer documentation answers dropshipment API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "dropshipment",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Dropshipment v2  - Createorder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://wbsapi.withings.nethttps://wbsapi.withings.net/v2/dropshipment",
            "params": [
              {
                "name": "action",
                "value": "",
                "type": "query",
                "description": "Service action name. Must take the string value ```createorder```."
              },
              {
                "name": "client_id",
                "value": "",
                "type": "query",
                "description": "Id of the client"
              },
              {
                "name": "nonce",
                "value": "",
                "type": "query",
                "description": "A random token used to prevent replay attacks (Cf. [Signature v2 - Getnonce](#operation/signaturev2-getnonce))"
              },
              {
                "name": "signature",
                "value": "",
                "type": "query",
                "description": "Hash of params (Cf. [Signature hash protocol](/developer-guide/v3/get-access/sign-your-requests))."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Refer to [Order model](#tag/models/Order). The maximum number of orders is 10 per API request."
              },
              {
                "name": "customerid",
                "value": "",
                "type": "query",
                "description": "Your dropshipment billing ID. If you don't know it, ignore this parameter."
              },
              {
                "name": "testmode",
                "value": "",
                "type": "query",
                "description": "If is set, it will create fake orders, and simulate the evolution of the orders status and sending of notifications.<br>```1```: ```SHIPPED``` sequence<br>```2```: ```TRASHED``` sequence<br>```3```: ```FAILED``` sequence<br>```4```: ```BACKHOLD``` sequence"
              },
              {
                "name": "platformid",
                "value": "",
                "type": "query",
                "description": "The platform ID"
              }
            ]
          },
          "docs": "Creates a dropshipment order.\n\nIf one of the orders has an invalid address, none of the orders will be created.\n\n*This service is part of Withings Pro Solutions. You won't be able to use it if you did not sign a contract with Withings.*\n*Do not use this service if you're integrating Withings Cellular Solutions with dropshipment. In that case, please use the createuserorder action*"
        },
        {
          "info": {
            "name": "Dropshipment v2  - Createuserorder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://wbsapi.withings.nethttps://wbsapi.withings.net/v2/dropshipment ",
            "params": [
              {
                "name": "action",
                "value": "",
                "type": "query",
                "description": "Service action name. Must take the string value ```createuserorder```."
              },
              {
                "name": "client_id",
                "value": "",
                "type": "query",
                "description": "Id of the client"
              },
              {
                "name": "nonce",
                "value": "",
                "type": "query",
                "description": "A random token used to prevent replay attacks (Cf. [Signature v2 - Getnonce](#operation/signaturev2-getnonce))"
              },
              {
                "name": "signature",
                "value": "",
                "type": "query",
                "description": "Hash of params (Cf. [Signature hash protocol](/developer-guide/v3/get-access/sign-your-requests))."
              },
              {
                "name": "mailingpref",
                "value": "",
                "type": "query",
                "description": "Specifies if customer accepted Withings commercial contacts."
              },
              {
                "name": "birthdate",
                "value": "",
                "type": "query",
                "description": "Unix timestamp of user's birthdate"
              },
              {
                "name": "measures",
                "value": "",
                "type": "query",
                "description": "User measures (Cf. [Measures](#tag/models/Measures) model)."
              },
              {
                "name": "gender",
                "value": "",
                "type": "query",
                "description": "0: man, 1: woman"
              },
              {
                "name": "preflang",
                "value": "",
                "type": "query",
                "description": "User language preference. Examples: en_EN / en_US / de_DE / es_ES / fr_FR / it_IT / ja_JA / ko_KR / nl_NL / pt_PT / ru_RU / zh_CN"
              },
              {
                "name": "unit_pref",
                "value": "",
                "type": "query",
                "description": "Unit pref (cf. [Unit preferences](#tag/models/Unit-preferences) model)."
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "User's email address"
              },
              {
                "name": "timezone",
                "value": "",
                "type": "query",
                "description": "User's timezone. Examples: \"Europe/Paris\" / \"America/New_York\". A complete list of all possible timezones can be found on the \"TZ database name\" column of this page : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"
              },
              {
                "name": "shortname",
                "value": "",
                "type": "query",
                "description": "3 characters representing the end user (ex: for a user named Robert, you could set the shortname param to ROB). These characters will be displayed on device screens when used.<br>Shortname must respect the following regex: /^[a-zA-Z0-9]{3}$/ (either letters or numbers, special characters and spaces are not allowed)."
              },
              {
                "name": "external_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier used by the partner to identify the end-user."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Refer to [Order model](#tag/models/Order). The maximum number of orders is 10 per API request."
              },
              {
                "name": "firstname",
                "value": "",
                "type": "query",
                "description": "User's firstname (if not set, will take the same value as shortname)"
              },
              {
                "name": "lastname",
                "value": "",
                "type": "query",
                "description": "User's lastname (if not set, will take the same value as shortname)"
              },
              {
                "name": "phonenumber",
                "value": "",
                "type": "query",
                "description": "Phone number in E.164 format. End user will receive a verification code on this phone number for 2 factor authentication if they wish to securely access the data of their program in the withings app in the future (recommended)"
              },
              {
                "name": "recovery_code",
                "value": "",
                "type": "query",
                "description": "Recovery code can be used by end user as a 2nd authentication factor in the withings app if they wish to securely access the data of their program in the future.  You will be responsible of securely providing this recovery code to your user if he asks for it."
              },
              {
                "name": "goals",
                "value": "",
                "type": "query",
                "description": "Goals (cf. [Goals](#tag/models/Goals) model)."
              },
              {
                "name": "testmode",
                "value": "",
                "type": "query",
                "description": "If is set, it will create fake orders, and simulate the evolution of the orders status and sending of notifications.<br>```1```: ```SHIPPED``` sequence<br>```2```: ```TRASHED``` sequence<br>```3```: ```FAILED``` sequence<br>```4```: ```BACKHOLD``` sequence"
              }
            ]
          },
          "docs": "Creates a Withings user, then creates a dropshipment order and links the devices shipped to the created user once the device is shipped. If a cellular device is listed in the order field, the service will activate this device's cellular service and invoicing.\n\nIf one of the orders has an invalid address, none of the orders will be created.\n\nPlease refer to the [Access and refresh tokens section](/developer-guide/v3/integration-guide/dropship-cellular/get-access/access-and-refresh-tokens) to lear"
        },
        {
          "info": {
            "name": "Dropshipment v2  - Delete",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://wbsapi.withings.nethttps://wbsapi.withings.net/v2/dropshipment   ",
            "params": [
              {
                "name": "action",
                "value": "",
                "type": "query",
                "description": "Service action name. Must take the string value ```delete```."
              },
              {
                "name": "client_id",
                "value": "",
                "type": "query",
                "description": "Id of the client"
              },
              {
                "name": "signature",
                "value": "",
                "type": "query",
                "description": "Hash of params (Cf. [Signature hash protocol](/developer-guide/v3/get-access/sign-your-requests))."
              },
              {
                "name": "nonce",
                "value": "",
                "type": "query",
                "description": "A random token used to prevent replay attacks (Cf. [Signature v2 - Getnonce](#operation/signaturev2-getnonce))"
              },
              {
                "name": "order_id",
                "value": "",
                "type": "query",
                "description": "Withings generated identifier used to track your order."
              }
            ]
          },
          "docs": "Cancels a dropshipment order.\nOnly orders that haven't been shipped can be cancelled.\nNote that there can be a latency between the shipping of the parcel and the update of the shipping status to *SHIPPED*.\nTrying to cancel an order that was already shipped will result in a error with error code 277.\n\n*This service is part of Withings Pro Solutions. You won't be able to use it if you did not sign a contract with Withings.*"
        },
        {
          "info": {
            "name": "Dropshipment v2  - Getorderstatus",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://wbsapi.withings.nethttps://wbsapi.withings.net/v2/dropshipment  ",
            "params": [
              {
                "name": "action",
                "value": "",
                "type": "query",
                "description": "Service action name. Must take the string value ```getorderstatus```."
              },
              {
                "name": "client_id",
                "value": "",
                "type": "query",
                "description": "Id of the client"
              },
              {
                "name": "signature",
                "value": "",
                "type": "query",
                "description": "Hash of params (Cf. [Signature hash protocol](/developer-guide/v3/get-access/sign-your-requests))."
              },
              {
                "name": "nonce",
                "value": "",
                "type": "query",
                "description": "A random token used to prevent replay attacks (Cf. [Signature v2 - Getnonce](#operation/signaturev2-getnonce))"
              },
              {
                "name": "order_ids",
                "value": "",
                "type": "query",
                "description": "DO NOT USE WITH FOLLOWING PARAMS: [customer_ref_ids]<br>List of order_id"
              },
              {
                "name": "customer_ref_ids",
                "value": "",
                "type": "query",
                "description": "DO NOT USE WITH FOLLOWING PARAMS: [order_ids]<br>Movement reference number of dropshipment orderlines"
              },
              {
                "name": "customerid",
                "value": "",
                "type": "query",
                "description": "Your dropshipment billing ID. If you don't know it, ignore this parameter."
              },
              {
                "name": "enrich",
                "value": "",
                "type": "query",
                "description": "Enable advanced features if set to 't'"
              }
            ]
          },
          "docs": "**This service is deprecated. Please use [Order v2 - Getdetail instead](#operation/orderv2-getdetail)**\n\nReturns dropshipment order information.\n\n*This service is part of Withings Pro Solutions. You won't be able to use it if you did not sign a contract with Withings.*"
        },
        {
          "info": {
            "name": "Dropshipment v2  - Update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://wbsapi.withings.nethttps://wbsapi.withings.net/v2/dropshipment    ",
            "params": [
              {
                "name": "action",
                "value": "",
                "type": "query",
                "description": "Service action name. Must take the string value ```update```."
              },
              {
                "name": "client_id",
                "value": "",
                "type": "query",
                "description": "Id of the client"
              },
              {
                "name": "signature",
                "value": "",
                "type": "query",
                "description": "Hash of params (Cf. [Signature hash protocol](/developer-guide/v3/get-access/sign-your-requests))."
              },
              {
                "name": "nonce",
                "value": "",
                "type": "query",
                "description": "A random token used to prevent replay attacks (Cf. [Signature v2 - Getnonce](#operation/signaturev2-getnonce))"
              },
              {
                "name": "order_id",
                "value": "",
                "type": "query",
                "description": "Withings generated identifier used to track your order."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Refer to [Order model](#tag/models/Order). Restricted to one order only."
              }
            ]
          },
          "docs": "Updates a dropshipment order.\n\n*This service is part of Withings Pro Solutions. You won't be able to use it if you did not sign a contract with Withings.*"
        }
      ]
    }
  ],
  "bundled": true
}