Subcuentas

Una subcuenta es una cuenta bajo una de las tuyas: una por tienda, sucursal o cliente, por ejemplo. Tiene su propio número de cuenta, su propia dirección de reenvío y sus propios envíos. No eres miembro de una subcuenta; llegas a ella a través de la cuenta principal a la que perteneces, con el mismo token de acceso.

Crear una subcuenta#

Envía el uid de la cuenta principal en accountUid y los datos de la nueva cuenta. Cuando perteneces a una sola cuenta puedes omitir accountUid: la subcuenta se crea bajo esa cuenta.

curl -X POST https://sandbox.weshipyou.com/api/v1/add-sub-account \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "accountUid": "h4jupn7wtfqp",
    "name": "Acme Imports Orlando",
    "displayName": "Acme Imports Orlando",
    "email": "orlando@example.com",
    "notificationEmail": "orlando@example.com",
    "phone": "+13055550100",
    "emergencyPhone": "+13055550101",
    "website": "https://example.com",
    "systemUnits": "imperial",
    "isBusiness": true,
    "language": "en"
  }'

La respuesta es la nueva cuenta: su uid, su accountNumber, su cuenta principal en parentUid y, en locker, la dirección de reenvío a la que se envían sus paquetes. Guarda el uid: es como nombras a la subcuenta en todas las demás llamadas.

Listar tus subcuentas#

GET /accounts devuelve en una sola lista las cuentas a las que perteneces y todas sus subcuentas. Distínguelas con parentUid: es null en una cuenta a la que perteneces y el uid de la cuenta principal en una subcuenta.

{
  "total": 2,
  "limit": 20,
  "skip": 0,
  "data": [
    { "uid": "h4jupn7wtfqp", "accountNumber": "000ACC1X16", "name": "Acme Imports", "parentUid": null },
    { "uid": "85js5f5clt2u", "accountNumber": "CUDHMFEDA9", "name": "Acme Imports Orlando", "parentUid": "h4jupn7wtfqp" }
  ]
}

Para obtener solo las subcuentas de una cuenta, pasa su uid, su número de cuenta o su número de cuenta externo en parentUid. La lista viene paginada: hasta 20 cuentas por defecto, 500 con $limit, y $skip para la página siguiente.

curl "https://sandbox.weshipyou.com/api/v1/accounts?parentUid=h4jupn7wtfqp" \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Lee una sola subcuenta por su uid con Obtener una cuenta.

Enviar en nombre de una subcuenta#

Tu token sirve para todas las subcuentas de tus cuentas: nombra la subcuenta en accountId. Para crear un envío que pertenezca a la subcuenta, envía su uid como accountId:

curl -X POST https://sandbox.weshipyou.com/api/v1/shipments \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d @shipment.json

con "accountId": "85js5f5clt2u" en shipment.json. Luego compra su etiqueta como se explica en Etiquetas.

Listar los envíos de una subcuenta#

Sin accountId, GET /shipments lista juntos los envíos de tus cuentas y de todas sus subcuentas. Pasa el uid o el número de cuenta de la subcuenta en accountId para obtener solo sus envíos.

curl "https://sandbox.weshipyou.com/api/v1/shipments?accountId=85js5f5clt2u" \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Quién ve qué#

Solo los miembros de la cuenta principal ven sus subcuentas. Un parentUid que nombra una cuenta a la que no tienes acceso devuelve una lista vacía, y un accountId o uid de cuenta al que no tienes acceso se rechaza.