dropshipment

Dropshipment v2 - Getorderstatus

This service is deprecated. Please use Order v2 - Getdetail instead

Returns dropshipment order information.

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.

posthttps://wbsapi.withings.net/v2/dropshipment

Request

  • Base URL
    https://wbsapi.withings.net
  • Auth
    none declared

Query parameters

actionstring required

Service action name. Must take the string value getorderstatus.

client_idstring required

Id of the client

signaturestring required

Hash of params (Cf. Signature hash protocol).

noncestring required

A random token used to prevent replay attacks (Cf. Signature v2 - Getnonce)

order_idsunknown required

DO NOT USE WITH FOLLOWING PARAMS: [customer_ref_ids]<br>List of order_id

customer_ref_idsunknown required

DO NOT USE WITH FOLLOWING PARAMS: [order_ids]<br>Movement reference number of dropshipment orderlines

customeridstring

Your dropshipment billing ID. If you don't know it, ignore this parameter.

enrichunknown

Enable advanced features if set to 't'

Response

(Click to unfold)

statusinteger

Response status. See <a href='#tag/response_status'>Status</a> section for details.

Example response

{
  "body": {
    "orders": [
      {
        "order_id": "D12345678",
        "customer_ref_id": "MOUVEMENTREFERENCE12345678",
        "status": "SHIPPED",
        "products": [
          {
            "ean": "3700546702518",
            "partner_ref": "REF-12345",
            "devices": [
              {
                "serial_number": "00:24:e4:xx:xx:xx",
                "mac_address": "00:24:e4:xx:xx:xx",
                "hash_deviceid": "892359876fd8805ac45bab078c4828692f0276b1",
                "model": "Pulse",
                "model_id": 51
              }
            ],
            "quantity": 3,
            "mac_addresses": [
              "00:24:e4:xx:xx:xx",
              "00:24:e4:xx:xx:xx",
              "00:24:e4:xx:xx:xx"
            ],
            "hash_deviceids": [
              "892359876fd8805ac45bab078c4828692f0276b1",
              "a1b2c3d4e5f6"
            ],
            "serial_numbers": [
              "SN-001122334455",
              "SN-001122334456"
            ]
          }
        ],
        "carrier": "UPS Parcel",
        "carrier_service": "Next Day Air",
        "tracking_number": "1ZY1111111",
        "parcel_status": "in_transit",
        "ship_date": "2024-03-15",
        "original_customer_ref": "MOUVEMENTREFERENCE00000001"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.