How it works
- Name the brand with
senderName. It replaces your company name wherever the shopper or the carrier sees the sender. - Optional return address. Send
returnAddresswhen returns for that order should go somewhere other than the location the parcel ships from. - Nothing else changes. Keep sending the
locationIdthe parcel leaves from. Pickups, delivery areas, and cutoff times work as before.
senderRef:
your own ID for the brand. It links the order to a brand that has its own logo
and branding, and is never shown to shoppers or carriers. A new senderRef
works straight away, with no setup per brand. Sparqle support sets up your
account as a fulfilment account.
Always send a senderRef
The ref is how Sparqle recognises a brand. It is matched exactly, so the same
ref always lands on the same brand and a new ref always creates a new one:
sending it is idempotent, and nothing depends on how a name is spelled.
Send it on every order that carries a senderName, and make it something that
is guaranteed unique in your own system, such as the client or brand ID. Never
derive it from the display name.
- Without a ref, the name is only printed. The order gets no brand of its own: no own logo or branding, and no protection against two clients using the same name. The name is shown exactly as sent.
- A name is not a safe key. Two clients can share a name, and a name can be
misspelled or renamed. With a ref, a wrong
senderNamecan at most print the wrong text on one parcel; it can never put a parcel under another client’s branding. - On accounts that ship for a single brand,
senderRefhas no effect. The sender name and return address still work as described above.
Create an order for a brand
The example is for a fulfilment account shipping for one of its clients.The registered name
Once a brand is registered, its registered name is shown on every order for thatsenderRef, whichever senderName you send. A typo or a renamed client
on your side can’t change what shoppers see, and a name can never link an
order to another brand.
If you send a different senderName for a known senderRef, Sparqle is
notified and can update the registered name with you. Sparqle support can also
register a brand before its first order.
Where the brand appears
When you leave the brand out, shoppers and carriers see your company name.
Where the return address appears
When you leave
returnAddress out, labels and the track and trace page show
the address of the location.
The return address does not change where the parcel is collected. Carriers
still pick up at the location’s address, and labels issued by a partner carrier
show that address as the sender address.
When an order is rejected
The order is rejected with a400 when:
senderRefis sent withoutsenderName.
Good to know
- The name is shown as you send it, unless the order carries a
senderRef, in which case the registered name is shown. It can be up to 100 characters. senderRefis matched exactly.5179823and5179823-NLare different brands. It can be up to 100 characters.- The ref is optional, but don’t leave it out. An order without it is still accepted and printed as sent, so a missing ref doesn’t fail loudly. Check that every integration path sends it.
- The return address is used as sent. It isn’t validated, so check it before you send it.
- Fixed at creation. The brand and return address are stored on the order and you can’t update them afterwards. Renaming a brand doesn’t change parcels already on their way.
- Billing stays with you. Orders for all brands are invoiced to your company.
A logo and branding per brand
Your own logo is left out whensenderName differs from your company name, so
shoppers never see it next to another brand. The track and trace page then
shows no logo, and tracking emails show the Sparqle logo and header. Your
colours and email wording stay the same.
Fulfilment accounts are the exception. Every brand, and every order sent
without a ref, uses the fulfilment account’s logo and branding by default.
Sparqle support can give each brand its own logo and its own branding on the
track and trace page and in tracking emails.
- Refs can be merged. If two
senderRefvalues turn out to be the same brand, ask Sparqle support to merge them. Orders move to the brand you keep, and future orders sent with either ref are linked to it. - A brand without its own branding uses yours. Email wording, the tracking events that trigger emails, and the language stay the same for all your brands.