Subcontas

Uma subconta é uma conta sob uma das suas: uma por loja, filial ou cliente, por exemplo. Ela tem o seu próprio número de conta, o seu próprio endereço de redirecionamento e os seus próprios envios. Você não é membro de uma subconta; você chega a ela pela conta principal da qual faz parte, com o mesmo token de acesso.

Criar uma subconta#

Envie o uid da conta principal em accountUid e os dados da nova conta. Quando você faz parte de uma única conta, accountUid pode ser omitido: a subconta é criada nessa conta.

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"
  }'

A resposta é a nova conta: o seu uid, o seu accountNumber, a conta principal em parentUid e, em locker, o endereço de redirecionamento para onde os pacotes dela são enviados. Guarde o uid: é como você identifica a subconta em todas as outras chamadas.

Listar as suas subcontas#

GET /accounts retorna numa única lista as contas das quais você faz parte e todas as subcontas delas. Diferencie-as por parentUid: é null numa conta da qual você faz parte e o uid da conta principal numa subconta.

{
  "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 obter somente as subcontas de uma conta, passe o seu uid, o seu número de conta ou o seu número de conta externo em parentUid. A lista é paginada: até 20 contas por padrão, 500 com $limit, e $skip para a próxima página.

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

Leia uma única subconta pelo seu uid com Obter uma conta.

Enviar em nome de uma subconta#

O seu token funciona para todas as subcontas das suas contas: identifique a subconta em accountId. Para criar um envio que pertença à subconta, envie o uid dela 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

com "accountId": "85js5f5clt2u" em shipment.json. Depois compre a etiqueta como descrito em Etiquetas.

Listar os envios de uma subconta#

Sem accountId, GET /shipments lista juntos os envios das suas contas e de todas as subcontas delas. Passe o uid ou o número de conta da subconta em accountId para obter somente os envios dela.

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

Quem vê o quê#

Somente os membros da conta principal veem as subcontas dela. Um parentUid que identifica uma conta à qual você não tem acesso retorna uma lista vazia, e um accountId ou uid de conta ao qual você não tem acesso é recusado.