Ship with
confidence.

WeiYa Shipping allows a user to create labels for their B2C shipments and drop them off at an Entry Point to ship to the customer. WeiYa gives sellers access to the global market and ships to 195 countries and territories, including the US, Canada, UK, and Australia. Our API also allows for integration into your current applications.

After creating a WeiYa account and authorising WeiYa Shipping, you will need to:

- Fill out your company information

- Update the return address for undeliverable shipments; return addresses default to a local WeiYa facility

- Select the Entry Point

- Add funds

Once your information is filled out and funds have been added, you are ready to create shipments!

Shipments can be created by:

- Create a single shipment by filling out the required information

- Upload shipments by CSV

Once your shipments are labelled, a notification will need to be sent to WeiYa Operations prior to drop off. Shipments can be packed into master cartons (up to 25kg per carton) for delivery to the Entry Point.

** To generate test labels, change your Entry Point to “Test, Test (TEST)” on the Ship Application Setup page. **

For customer service, balance and credit inquiries, or other questions, you can use the following
information to contact us.
Online: your WeiYa account
E-mail: info@myweiya.com

To sign up to WeiYa’s online shipping management portal, visit your WeiYa account and click Create Account. If you already have a WeiYa account, click Sign In and skip to the next section. The information requested is for use on the account and has no bearing on any of the services supplied by WeiYa. Once signed up, you will receive an email confirming your account setup.

Once you sign in to the Ship application, you will be prompted to enter some account and shipping configuration details.

Ship Settings

Entry Point
This is the location where you will drop your packages off to WeiYa. To begin with, select
“Test”. All shipments generated for the “Test” location will be test labels. You will
be able to generate labels for this location with no balance ($0.00). To generate live/production
labels, you will need to change to a production entry point and have sufficient funds in your
account.

Account Console

Company Address
The company information must relate to the entity who is acting as the shipper. The shipper is the party who sold the goods being shipped to the consignee/customer.

Note: If you are a consolidator, you will need to use the API to assign the correct shipper to each shipment.

All information must be submitted in English.

This information can be changed at any time by going to the Account Console page which can be found by clicking on your username at the top right hand side of the screen.

Return Address
For WeiYa Shipping application users, the return address can be set in your Account Console. The company name provided will appear on the return address of all labels even if you do not set a return address. If you do not set a return address, the system will use one of WeiYa’s return centers in the U.S. by default. For API users, you are able to modify the return address for each shipment.

The WeiYa Fulfilment application provides WeiYa customers with a user interface to access most features from the WeiYa Fulfilment API.

Download the WeiYa Fulfilment Instructions.

A new shipment will need to be created for every parcel prior to arriving at the Entry Point.

All shipment information must be submitted in English. Value must be declared in US Dollars (USD).

Shipment information must be as accurate as possible. Inaccuracies/false declarations may result in shipment delays and fines. WeiYa is not responsible for the delays due to inaccuracies and all fines occurred are charged to your WeiYa Account.

WeiYa will charge by the dimensional weight if it is greater than the actual weight.

The minimum chargeable weight is 100 grams.

Only one label is generated per shipment, which can be reprinted. If any information needs to be changed, the shipment needs to be cancelled and recreated. No changes can be made once WeiYa processes the shipment.

Labels are downloaded from your WeiYa account as a PDF. Labels can be downloaded one-by-one or in bulk. Bulk label downloads are a multi-page PDF file including up to 100 labels.

Labels should be placed wholly on the largest flat surface of the parcel making sure that the entire label (including delivery and return address, barcode and tracking number) is legible once attached. Improper labels can cause a lack of tracking information available and/or the shipment to be undelivered.

The shipment label is the only documentation required to be included on the shipment.

Labels cannot be created if the account as an insufficient balance. Test labels can be created by changing your Entry Point to “Test, Test (TEST)” on the Ship Application Setup page.

WeiYa offers light address verification, which can be overridden. It is the shipper's responsibility to validate shipping addresses.

The shipper is responsible for complying with customs, regulations, and laws of destination countries.

You can create individual shipments here.

All fields marked with * are required.

Some destination countries will require a phone number.

The Tax/Passport ID is referencing the consignee’s Tax/Passport ID, which is required information for some destination countries.

Pinyin is not allowed to be used as an Entry Point language.

Once the information is added, you can get an estimate, select the service level, and create the shipment.

Importing by CSV

Shipments can be imported by CSV here. There is a template in your WeiYa Account and a downloadable one at the bottom of this article.

Once the CSV file is imported to WeiYa, it will start creating shipments. A report will be available after to show which shipments were created in WeiYa and if there are any errors preventing a shipment to import. If you need to correct an error, do not upload the same sheet with the successfully imported shipments with the correction(s). Uploading a sheet with shipments that are already in WeiYa will cause duplicates.

Once you have created shipments in WeiYa, you can search for a shipment by the WeiYa ID, consignee name, reference ID(s), and tracking number.

*** Assuming all the supplied data is correct, this estimate will be equal to the actual amount invoiced. Any variation to address, weight, or dimensions may affect this price.***

Shipments > Search

Use this page to view and access all your shipments (past and present) including:

• Bulk print shipping labels
• Bulk cancel shipping labels
• Filter shipments by date created and label / over-packed status
• Export shipment report
• View shipment (Click the shipment ID)
• View shipment tracking
• Shipment options:
  • View Shipment
  • Print Label
  • Cancel
  • Track

Bulk Print

This button can be used to bulk print all visible, selected labels. Use the checkbox to the left of
the shipment ID field to select specific shipments to print. You can bulk print up to 100 labels at
a time.

Bulk Cancel

This button can be used to cancel one or more shipping labels at once. Only labels that have
not been processed and are not yet in an overpack can be cancelled. Use the checkbox to the
left of the shipment ID field to select specific shipments to cancel. Once a label has been
cancelled, the charge will be returned to the account balance.

Cancelled shipments are not deleted. New labels can be created for cancelled shipments.

A shipment’s information can’t be edited after it is created. Instead, you will need to cancel the label. No changes, including cancelation, can occur after WeiYa processes the shipment.

Search for the shipment in your WeiYa Account.

Once the shipment details pull up, scroll down to the “Labels” section. Select “Options” and “Cancel” on the far right.

A pop-up message will appear to confirm you want to cancel the order. After confirming, you will have the option to Edit or Delete the shipment.

Edit will take you back to Create Shipment and the shipment information will auto-populate. Following the same steps as creating a shipment, changes can be made and a new label will be created.

Delete will erase the shipment and its information from the system, and you will be taken back to the shipment search page.

Detailed Product Description Guide (Best Practice)

• Apparel/Textile Accessories:
  1. Gender
  2. Knit or woven
  3. Type of garment/accessory
  4. Fiber Contents (including weight percentages of fibers)
  Example: Ladies Woven Blouse 100% Polyester

• Shoes:
  1. Gender
  2. Type of shoe (i.e. boot, slipper, flat)
  3. Content of upper
  4. Content of outsole
  5. Covers ankle, covers calf or does not cover ankle
  6. Is the vamp made of straps or one or several pieces cut out
  7. If it has vamp straps or cut outs, is the sole and heel combined have a height
  of more than 3 cm
  Examples:
  Ladies sandal, textile upper, rubber sole, does not cover ankle
  Ladies heels, leather upper, rubber sole, does not cover ankle, has vamp cut outs
  with a heel
  greater than 3 cm
  Men’s boots, leather upper, rubber sole, covers ankle and calf

• Jewelry/Hair Accessories:
  1. Material content
  2. Indicate if precious metal, semiprecious, or precious stones are used
  3. Type of jewelry (i.e. bracelet, necklace, etc.)
  4. If there are textile components, indicate the fabric content and knit or woven
  Example: Base metal post earrings; Plastic headband

• Handbags/Wallets:
  1. Fiber contents (i.e. textile, polyurethane/plastic, leather)
  2. Type of item
  Example: Cotton handbag with leather trim

• Belts:
  If textile:
  1. Knit or woven
  2. Type of accessory
  3. Material Content of the inside of the belt that hugs the waist (including
  weight percentages of fibers)
  Example: Woven Belt 50% Cotton/50% Polyester
• If non-textile:
  1. Material Content of the inside of the belt that hugs the waist 2.
  2. Type of accessory
  Example: 100% polyurethane belt

• Gloves:
  1. Gender
  2. Knit or woven
  3. Material content
  4. If coated with plastic or rubber
  Example: Ladies Knit Gloves 100% Wool

• Hats:
  1. Gender
  2. Knit or Woven
  3. Type of item
  4. Fiber content
  Example: Mens Woven Hat 100% wool

• Sunglasses:
  1. Material content
  2. Type of glasses (i.e. sunglasses or reading)
  3. Material of lens
  Example: Base metal sunglasses with plastic lens

• Textile Linens:
  1. Knit or woven
  2. Type of item
  3. Fiber contents (including weight percentages)
  4. Printed or not printed
  5. If bedding, include if quilted or not quilted
  6. Filled with feathers or down or not
  Example: Woven Tablecloth 100% Cotton; Woven Duvet 100% Cotton, not quilted,
  not printed

• Clocks:
  1. Type of clock (i.e. clock with watch movements, alarm clock, wall clock, etc.)
  2. Electrically operated or not
  Example: Alarm clock, battery operated

• Watches:
  1. Electrically operated or winding mechanism
  2. Display type (mechanical display or opto-electronic display)
  3. Whether it has stop watch capabilities or not
  4. Type of item
  Example: Electrically operated watch with mechanical display, does not have
  stopwatch

• Cosmetics/Beauty Products:
  1. Type of item
  2. Type of container that product is in
  3. Net quantity of each unit
  4. Contains alcohol or does not contain alcohol
  Examples:
  Lip gloss, Mascara
  Hand lotion in plastic tube does not contain alcohol, 30 grams

• Rugs:
  1. Knit or woven
  2. Type of item
  3. Material Content
  4. Knotted or not knotted
  5. Pile construction or non-pile construction
  6. Tufted or not tufted
  7. If rug has tiles, surface area of the tiles
  8. Dimensions
  Example: Woven Rug 100% Cotton, non-pile construction, not tufted,100 cm x 100 cm

• Umbrellas:
  1. Type of umbrella (i.e. handheld or garden)
  2. Telescoping shaft or non-telescoping shaft
  Example: Handheld umbrella with telescoping shaft

• Furniture:
  1. Material content
  2. Upholstered or not upholstered (for chairs and sofas only)
  3. Type of furniture (i.e. chair, sofa, table, etc.)
  4. For indoor or outdoor use
  Example: Upholstered indoor chair with wooden frame

• Pillows:
  1. Fiber contents (including weight percentages)
  2. Type of fill (polyfill or down)
  Example: 100% cotton woven pillow with polyfill

• Wall Art:
  1. Whether image is printed or embroidered
  2. Type of item
  3. Framed or not framed
  Example: Printed wooden wall art with frame

• Mirrors:
  1. Type of item
  2. Framed or not framed
  3. Reflective dimensions in CM2

• Wallpaper:
  1. Item
  2. Coated or non-coated
  Example: Coated wallpaper

• Electronic Accessories:
  1. Material content
  2. Type of item
  3. Number of speakers (if the item has speakers)
  4. Whether it emits radio frequency or not
  Example: Plastic stereo with 2 speakers

• Books:
  1. Hardbound or softbound
  2. Type of book (i.e. art/pictorial, children’s)
  3. Number of pages
  Example: Hardbound art book with 350 pages

• Lighting:
  1. Material Content
  2. Type of light (i.e. chandelier, lamp, wall light etc)
  3. Wired or not wired
  4. Whether for household use or not
  Example: Iron table lamp

• Candles:
  1. Type of item
  Example: Candle

• Utensils/Drinking Glasses/Serveware:
  1. Material content
  2. Type of item
  3. Has stem or not
  4. If it has etched/engraved glass
  5. Indicate whether it is food/drink safe or not
  Example: Stem drinking glass, etched, food safe

• Toys/Novelty Items:
  1. Material content
  2. Type of item
  Example: Polyester stuffed animal
  

Label Guidelines

• Apply label to largest flat surface.

• Do not apply label across packaging flaps or folds as this risks label damage in transit.

• Label must be printed at original size, do not crop or resize.

• Complete label must be visible, do not cover any portion with another label, tape or other material.

• Label must be 10x15cm/4x6in and self adhesive. Do not use plain paper and tape.

• Label barcodes with folds or creases will result in missing scan events or loss.

• Ensure clear printing by cleaning your label printer heads regularly.

• Poor quality printer or label stock will result in unscannable labels.

• No other barcodes visible on the same packaging side as the label.

• Labels should be applied with barcode vertically aligned when tube is set on its end as below.

See attached guide for more detailed information.

To ensure sufficient air capacity and processing labor, we suggest providing a pre-alert by 5pm the day prior to handover. We also recommend handing over shipments prior to 3pm for same day processing (mark this in the pre-alert).

Use this template to notify your Entry Point of drop off.

To: Contact support for contact information.

Subject: (USERID) DELIVERY PREALERT DDMMYY-01

Content – see below

Hi WeiYa team,

Vehicle registration/tracking number: ABC123

Estimated Arrival: 28MAY BEFORE 15:00HRS / AFTER 15:00HRS

Manifested/Shipment Summary:

This can be provided as a manifest showing all shipment detail (e.g. system generated) or a summary of destinations with >50packages included in the shipment.

Shipment Summary (inside the email body):

Shipment Manifest (attachment) Headings:

Delivery confirmation (by tracking) is available free for all services. Signature confirmation is available for a per parcel fee.

Two notices are left (Day 0 and Day 5) and parcels are held at the post office for a total of 15 days before being returned to the return address.

Yes, after obtaining permission through your account representative. MSDS and Shippers Declaration are required for shipments travelling by air with all WeiYa products. All goods must be tendered in accordance with IATA labelling and packaging standards.

Tracking is available for at least 3 months on the WeiYa website.

Yes. You can send B2B cargo with us, including shipments into Amazon FBA warehouses. Tell your account manager what you’re sending and where, so we set up the right clearance for each shipment. For help, email info@myweiya.com.

Custom return addresses are only allowed for shipping addresses in the US, GB, CA, and AU. If you do not have a returns address, a WeiYa address will be used by default. Rest-of-world shipments always use a default return address. We also provide a return service for shipments that are returned so they can be consolidated or reshipped.

Prohibited and dangerous items can be viewed here. Contact your account representative for specific questions.

DDU (Delivered Duties Unpaid)

Upon arrival at the destination country, the courier/post office will require payment of taxes/duties from the recipient prior to delivery. Usually there is an additional service charge to the recipient.

DDP (Delivered Duties Prepaid)

Taxes/duties are billed to your WeiYa account; this delivers a better experience for the end consumer as there is no delay and nothing extra to pay. We don’t add a service fee for DDP.

1. Enter the service member's full name and rank for Name.
2. Include their unit and PO box for Street 1.
3. The City will need to be one of the abbreviations below:

• APO: Army Post Office
• FPO: Fleet Post Office
• DPO: Diplomatic Post Office

1. The State/Province needs to be assigned a ‘state code’ that is categorised by one of the following abbreviations:

• AA: Armed Forces Central and South Americas (Armed Forces Americas)
• AP: Armed Forces Pacific
• AE: Armed Forces Europe (including Canada, Middle East, and Africa)

1. The Country is “US”, as these addresses are considered part of the United States.

• Shipment address number, street, box number, route number, or geographical section of city or city and state is wrong or missing.
• The recipient moved from the shipment address and left no forwarding address.
• The recipient moved and left a forwarding address but the forwarding address has expired.
• The shipment was not picked up after notice(s) left.
• Delivery was attempted but the recipient was not known at the address.
• Delivery was attempted but the recipient refused delivery, which is common for DDU shipments.
• The house, apartment, office, or building of the address is vacant.
• The recipient is deceased.

MEASURING OVERLAPPING EDGES

• Measure to the nearest inch (centimeter).
• Use the greatest measurement in each direction.
• For example: Measure A x B x H, not C x D x H

MEASURING CYLINDERS

• Calculate the volume using the diameter as the length and width.
• For example: Measure D x D x H
• The box has the same dimensional weight as the cylinder.

MEASURING IRREGULAR SHAPES

• Place the package in a corner in the position it will be loaded. Measure by holding a straight edge at the right angles to the wall.
• For example: Measure L x W x H

TO CALCULATE VOLUME (EXAMPLES OF CALCULATION)

The formula for calculating the dimensional weight for all commodities is 166 cubic inches per pound(6000 cubic centimeters per kilogram or 366 cubic inches per kilogram). Multiply the length by the width by the height to obtain the cubic inches (cm).

• To obtain the dimensional weight in kilograms, divide the cubic inch result by 366.
• To obtain the dimensional weight in pounds, divide the cubic inch result by 166.
• To obtain the dimensional weight in kilograms, divide the cubic centimeter result by 6000.

If the dimensional weight is greater than the actual weight, use it to calculate the shipping charges.

US - Zones - Coverage - Area Surcharge - FSC

CA - Zones - Coverage

AU - Zones

GB - Remote

One or more Demand Surcharges will apply to UPS packages shipped during the specified Demand Periods (inclusive of any applicable starting and ending dates) for the origins, destinations, and service levels and in the amounts set forth below. Demand Surcharges apply in addition to all other applicable Charges.

Demand Surcharge – Applied to Additional Handling, Large Packages and Over Maximum

A Demand Surcharge will apply to packages that require Additional Handling and Large Packages for all U.S. domestic, U.S. import, and U.S. export shipments. A Demand Surcharge will apply to all packages that are Over Maximum Limits for all U.S. domestic, U.S. import, and U.S. export shipments. The Demand Surcharges will apply in the amounts set forth below.

Demand Surcharge – Applied to UPS® Air and UPS® Ground Residential Packages

A Demand Surcharge will apply to all UPS Air and UPS Ground Residential packages:

The U.S. Postal Service filed notice with the Postal Regulatory Commission (PRC) regarding a temporary price change for some package products for the 2026 peak holiday season. This temporary price adjustment is to help cover extra handling costs to ensure a successful peak season.

The planned change for peak season, which was approved by the governors of the Postal Service, would affect prices on the following retail and commercial domestic competitive parcels: Priority Mail Express (PME), Priority Mail (PM), USPS Ground Advantage, and Parcel Select. No other products or services would be affected. Pending favorable review by the PRC, the temporary rates would go into effect at 12 a.m. CT on Oct. 4 and remain in place until 12 a.m. CT on Jan. 17, 2027.

Priority Mail and USPS Ground Advantage: Zone 1-4

• $0.40 cents increase for Zones 1-4, 0-3 lbs.
• $0.65 cents increase for Zones 1-4, 4-10 lbs.
• $1.05 cents increase for Zones 1-4, 11-25 lbs.
• $3.15 increase for Zones 1-4, 26-70 lbs.

Priority Mail Zone 5-9

• $0.85 cents increase for Zones 5-9, 0-3 lbs.
• $1.75 increase for Zones 5-9, 4-10 lbs.
• $3.85 increase for Zones 5-9, 11-25 lbs.
• $9.10 increase for Zones 5-9, 26-70 lbs.

USPS Ground Advantage Zone 5-9

• $0.55 cents increase for Zones 5-9, 0-3 lbs.
• $1.05 cents increase for Zones 5-9, 4-10 lbs.
• $1.75 increase for Zones 5-9, 11-25 lbs.
• $7.70 increase for Zones 5-9, 26-70 lbs.

U.S. Postal Service Announces Temporary Price Change for 2026 Holiday Shipping Season

One or more Demand Surcharges will apply to FedEx packages shipped during the specified Demand Periods (inclusive of any applicable starting and ending dates) for the origins, destinations, and service levels and in the amounts set forth below. Demand Surcharges apply in addition to all other applicable Charges.

Demand Surcharge – Applied to Additional Handling, Large Packages and Over Maximum

A Demand Surcharge will apply to packages that require Additional Handling and Large Packages for all U.S. domestic shipments. A Demand Surcharge will apply to all packages that are Over Maximum Limits for all U.S. domestic shipments. The Demand Surcharges will apply in the amounts set forth below.

Demand Surcharge – Applied to FedEx Ground, Express and Overnight Packages

A Demand Surcharge will apply to all FedEx Ground, Express and Overnight packages:

DHL eCommerce will implement temporary Peak Season Surcharges to help support increased network demand, predictability, and maintain service reliability during this high-volume period. Peak Season Surcharges will apply to packages shipped during the specified periods (inclusive of the applicable starting and ending dates) in the amounts set forth below.

Peak Season Surcharge – Domestic Parcel and BPM Products

A Peak Season Surcharge will apply to DHL eCommerce domestic Parcel Ground, Parcel Expedited, Parcel Plus, Parcel Expedited Max, and BPM services. The surcharge varies by service level, package weight, destination zone, and applicable demand period. All amounts are in USD per package.

Peak Season Surcharge – Domestic Return Products

A Peak Season Surcharge will apply to DHL eCommerce domestic Parcel Return Light, Parcel Return Ground, and Parcel Return Plus services. The surcharge varies by service level, package weight, and destination zone. The following rates apply throughout all three Peak Season Surcharge periods, from October 25, 2026 through January 16, 2027. All amounts are in USD per package.

Peak Season Surcharge – International Products (U.S. Outbound)

A Peak Season Surcharge will apply to DHL eCommerce international products shipped outbound from the United States, including Packet International, Parcel International Standard, Parcel International Direct, Parcel International Expedited, and applicable SMB services. The surcharge will apply in the amounts set forth below. All amounts are in USD per package.

Some carriers, including UPS and FedEx may apply an Additional Handling Surcharge when a package is not packed in a standard way or cannot move safely and efficiently through the carrier’s automated sorting network.

This article covers packaging-related Additional Handling only. Separate charges may apply because of a package’s weight, dimensions, cubic volume, or oversize classification.

Most parcel networks are designed around rigid, rectangular packages that are completely enclosed in corrugated cardboard.

A package may require manual handling when its shape, material, wrapping, or external features prevent it from moving normally through conveyor and sorting equipment.

The surcharge may still apply when the package is strong enough to protect its contents. The issue is not limited to package strength; it also concerns compatibility with the carrier’s handling system.

Examples that may be assessed for an AHS Surcharge

1. Plastic pail

Recommendation: Place the pail inside a properly sized corrugated carton with suitable internal cushioning.

2. Long triangular package

Recommendation: Use a rigid rectangular corrugated carton where practical and enter the final packed dimensions accurately.

3. Irregular item wrapped in plastic

Recommendation: Place the item inside a six-sided corrugated carton and use internal blocking or cushioning to prevent movement.

4. Long, heavily taped package

Recommendation: Use a correctly rated carton designed for long products. Avoid combining or extending smaller cartons unless the packaging is engineered for shipment.

5. Exposed tire

Recommendation: Fully enclose the tire in a suitable corrugated shipping container where permitted by the carrier.

6. Bundled soft packages

Recommendation: Place the individual packages inside one rigid corrugated master carton rather than strapping them together externally.

7. Stretch-wrapped parcel

Recommendation: Use a sealed corrugated carton as the external shipping surface. Do not use stretch-wrap as the parcel’s primary outer packaging.

8. Carton with external banding

Recommendation: Use suitable pressure-sensitive packing tape instead of external plastic, metal, or cloth straps.

9. Exposed frame or protruding components

Recommendation: Fully enclose the product in a rigid corrugated carton and use internal supports to prevent components from piercing the carton.

10. Wooden crate

Recommendation: Use an appropriately rated corrugated shipping carton where possible. Consider freight service when a wooden crate is necessary.

11. Reusable rigid shipping case

Recommendation: Place the case inside a corrugated overbox where practical, or use a freight service if the item is unsuitable for parcel handling.

12. Fabric or material rolls

Recommendation: Pack the rolls inside a rigid rectangular corrugated carton with end supports and internal blocking.

Important

The examples above are illustrative and are not an exhaustive list.

Carriers may assess Additional Handling when a package requires special manual handling, is incompatible with automated equipment, or does not meet their standard packaging requirements.

Packaging definitions, surcharge amounts, and charging rules vary by carrier, country, service, date, and customer agreement. The carrier’s current service guide and terms in effect on the shipment date take precedence.

Routes closed; mail and package delivery not possible. At this time we do not know when the situation changes, nor can we tell you when routes reopen. The situation changes per country. Note: we update this list regularly.

Tax rates and de minimis values for DDP (Delivery Duty Paid) shipments.

• Aerosols
  Including spray paints, lacquers, solvents, air fresheners, oven cleaners, deodorants, body sprays, hair sprays, shaving and hair removal creams.

• Alcoholic beverages
  Alcoholic beverages including absinthe, gin, vodka, whiskey, beer, lager, wine and champagne.

• Ammunition
  Except lead or steel pellets and other airguns and air-soft projectiles.

• Animal products and animal by-products
  Meat, milk, egg, poultry, and their products, including products made with these materials, such as dried soup mix or bouillon, are prohibited.

• Asbestos
  In any form.

• Balloons filled with non-flammable gas
  Helium.

• Batteries
  Batteries that are classed as dangerous goods by the latest edition of the International Civil Aviation Organization’s (ICAO) Technical Instructions are prohibited. This includes lithium ion/polymer/metal/alloy batteries sent in isolation or with equipment. Lithium ion/polymer/metal/alloy batteries when sent contained in equipment such as a mobile phone or digital camera are allowed. Lead acid batteries (e.g. car batteries) and sealed lead acid batteries
  are also prohibited. Alkaline, nickel metal hydride (NiMH) and nickel cadmium (NiCd) batteries are also prohibited.
  

• Biological Substances
  Human or animal material including, but not limited to, urine, excreta, secreta, blood and its components, tissue and tissue fluids.

• Clinical and medical waste
  For example contaminated dressings, bandages and needles.

• Controlled drugs and narcotics
  Including cannabis, cocaine, heroin, LSD, opium and amyl nitrate.

• Corrosives
  Substances which can cause severe damage to living tissue, other freight or transport by its chemical action are prohibited including aluminum chloride, caustic soda, corrosive cleaning fluid, dyes, acids,
  corrosive paint and rust removers, mercury and gallium metal.

• Counterfeit currency, bank notes and postage stamps
  Including any false instrument, or copy of a false instrument except copies of old denominations, which are now obsolete and worthless except for collectible value and cannot be passed as tender.

• Counterfeit trademarked and copyrighted products
  Products bearing marks that are counterfeit or inappropriately using a federally registered trademark are prohibited. Products bearing marks that are confusingly similar to a registered trademark, and restricted gray market products (goods bearing genuine marks not intended for United States importation) are prohibited. Products that are piratical of a protected copyright, i.e., unauthorised articles that are substantially similar to a material protected by a copyright, are prohibited.

• Cultural artifacts and property
  Art/artifacts/antiquities; archaeological and ethnological material are also terms used to describe this material.

• Dog and cat fur
  It is illegal in the United States to import, export, distribute, transport, manufacture or sell products containing dog or cat fur.

• Drug paraphernalia
  It is illegal to bring drug paraphernalia into the United States unless prescribed for authentic medical conditions.

• Dry ice
  For example UN1845 when used as a coolant for UN3373 or for other perishable items.

• Electronic items sent with lithium ion/polymer/metal/alloy batteries
  Electronic items sent with lithium ion/polymer/metal/alloy batteries where the battery is not contained in electronic equipment are prohibited. Lithium ion/polymer/metal/alloy batteries when sent contained in electronic equipment such as a mobile phone or digital camera are allowed

• Electronic items containing any batteries exceeding 100Wh
  Including some high performance laptops and power tools.

• Environmental waste
  Including used batteries and used engine oil.

• Explosives
  Any chemical compound, mixture or device capable of producing an explosive or pyrotechnic effect with substantial instantaneous release of heat and gas is prohibited e.g. ammunition, blasting caps, fireworks, flares, fuses, igniters and nitro-glycerine. Items that appear to be prohibited explosive ordnance may be subject to additional checks and delays.

• Firearms
  Except paintball, bb guns, and other guns that use compressed gas, compressed air or mechanical spring action to fire a projectile/pellet.

• Fish and wildlife
  Wild birds, land or marine mammals, reptiles, fish, shellfish, mollusks or invertebrates; Any part or product of the above, such as skins, tusks, bone, feathers, or eggs; or Products or articles manufactured from wildlife or fish. Endangered wildlife species and products made from them may not be imported. Items prepared as food may be acceptable in some cases.

• Flammable liquids
  This includes mixtures of liquids or liquids containing solids in solution or suspension which give off a flammable vapor. Any liquid with a closed cup flash point below 60.5° C is prohibited e.g. acetone, benzene, cleaning compounds, gasoline, lighter fuel, paint thinners and removers, petroleum and solvents, certain alcoholic beverages, perfumes and aftershaves, varnishes and enamels including nail polish.

• Flammable solids
  Solid materials which are liable to cause fire by friction, absorption of water, spontaneous chemical changes or retained heat from manufacturing or processing, or which can be readily ignited and burn vigorously e.g. adhesives, calcium carbide, cellulose nitrate products, fire lighters, matches, metallic magnesium, nitro-cellulose based film, phosphorous, potassium, sodium, sodium hydride, zinc powder, zirconium hydride.

• Frozen water
  Including packs of ice

• Gases
  Gases that are compressed, liquefied or dissolved under pressure, permanent gases which cannot be liquefied at ambient temperatures, liquefied gases which become liquid under pressure at ambient temperatures, dissolved gases which are dissolved under pressure in a
  solvent.
  1. All flammable compressed gases are prohibited e.g. blowlamps; butane; lighters and refills containing flammable liquid or gas; ethane; gas cylinders for camping stoves; hydrogen; methane and propane.
  2. All toxic compressed gases are prohibited e.g. chlorine; fluorine etc.
  3. All non-flammable compressed gases are prohibited e.g. air bags;
  scuba tanks, carbon dioxide; fire extinguishers; neon and nitrogen.

• Human and animal remains
  Including ashes.

• Infectious substances UN2814 or UN2900
  Category A Infectious Substances are prohibited e.g. Ebola, Anthrax, Foot and Mouth disease as detailed in the latest edition of the International Civil Aviation Organization’s (ICAO) Technical Instructions.

• Lighters and refills containing flammable liquid or gas
  Including used butane and petrol cigar and cigarette lighters. New and unused empty lighters are allowed.

• Liquids over 1 liter
  Including water.

• Living creatures, animals and reptiles
  Except certain insects and invertebrates.

• Magnetised material
  Magnetised material with a magnetic field strength of 0.159A/m or more at a distance of 2.1m from the outside of the package.

• Matches
  Of any kind, including safety and windproof matches.

• Nail varnish, polish or gel
  Including nail polish remover.

• Obscene publications and unlawful indecent images
  Obscene or extreme pornographic images and videos in magazines, CD's, DVD's and other formats.

• Oxidising materials and organic peroxides
  These are substances such as disinfectants that may cause or contribute to combustion of other substances. They may also be liable to explosive decomposition, react dangerously with other substances and injure health e.g. bromides, chlorates, components of fiberglass repair kits, disinfectants, nitrates, per chlorates, permanganates and peroxides, including hair dyes and colorants containing peroxide.

• Perishables
  Including flowers, fruit and vegetables; and frozen or chilled foodstuffs. Frozen water and dry ice are prohibited.

• Plants and seeds
  Some plants, cuttings, seeds that are capable of propagation, unprocessed plant products and certain endangered species are allowed into the United States but require import permits and other documents; some are prohibited entirely.

• Poisonous, toxic liquids, solids or gases
  Including substances that are liable to cause death or injury if swallowed or inhaled or by skin contact, such as arsenic, beryllium, cyanide, fluorine, rat poison.

• Prescription medicines and vaccines
  As a general rule, the FDA does not allow the importation of prescription drugs that were purchased outside the United States.

• Radioactive materials
  Radioactive materials and samples that are classified as radioactive using Table 2-12 of the latest edition of the International Civil Aviation Organization’s Technical Instructions e.g. fissile material (uranium 235, etc), radioactive waste material, thorium or uranium ores and luminous dials from aircraft.

• Solvent-based paints, wood varnishes and enamels
  Including gloss paint.

• Waste, dirt, filth or trash
  Including household waste or trash.

• Weapons
  Including knives, razors, and other sharp instruments, CS gas and pepper sprays, tasers and stun guns.

WeiYa respects local and international rules and laws implemented in the context of strengthening global security through international sanctions. Therefore any shipment with WeiYa could require review or prevented if the shipper or the receiver involved in the transaction is linked to an individual or entity that is on a country or international Denied Parties list or its content or destination breaches country-based sanctions.

Denied Parties are individuals or entities that have been denied shipping privileges by government agencies because they are involved in illegal activities such as drug trafficking, money laundering or terrorism. Any transactions with someone on this list that would violate the terms of its denial order are limited or even prohibited. Country-based sanctions are where the sanctions apply to the country/territory as a whole and not specific individuals.

Every shipment created in WeiYa is screened in order to point out any anomaly or a possible link to any of the country or international Denied Party lists we screen against or that could breach the country-based sanctions. Our mission is to ensure that we don’t carry any shipment from or to a Denied Party or, deliver any item which breaches country-based sanctions, that can result in fines or penalties to consignors or carriers.

Many products imported into the United States are regulated by the U.S. Food and Drug Administration (FDA) in addition to U.S. Customs and Border Protection (CBP). FDA-regulated goods can include food, dietary supplements, cosmetics, medical devices, human drugs, radiation-emitting electronic products, animal and veterinary products, tobacco products, and certain food-contact articles.

For logistics companies and shippers, FDA handling has three separate layers:

1. Applicability: determine whether FDA regulates the product and which FDA program applies.
2. Compliance: confirm that the product, labelling, facility registrations, listings, approvals or other regulatory requirements are satisfied where applicable.
3. Entry transmission: provide the FDA data required for the import entry through ACE/PGA.

Important: transmitting FDA data does not make a non-compliant product compliant. FDA may review the entry, request documents, examine or sample the goods, detain the shipment, or refuse admission if the product appears to violate applicable requirements.

FDA and CBP perform different roles

CBP manages the customs entry. FDA determines the admissibility of FDA-regulated goods under the laws it administers. A shipment may therefore have a valid customs entry while FDA is still reviewing the regulated lines.

Recommended workflow before shipping

1. Identify whether the product is FDA regulated.
2. Identify the FDA program and product code.
3. Confirm the intended use and any program-specific data.
4. Confirm applicable registrations, listings, prior notice, FSVP or other compliance requirements.
5. Check labelling and product compliance before the goods leave origin.
6. Check relevant FDA Import Alerts where risk exists.
7. Transmit complete and accurate FDA information with the shipment.

Sources

• FDA Import Program
• CBP PGA Message Set

FDA jurisdiction depends on the product and its intended use. The fact that a shipment is small, low value, promotional, a sample, or shipped by parcel carrier does not by itself remove FDA requirements.

Common product groups regulated by FDA

• Human food and beverages
• Dietary supplements
• Cosmetics
• Human drugs, including many over-the-counter products
• Medical devices
• Radiation-emitting electronic products
• Animal food, animal drugs and other veterinary products
• Tobacco products
• Certain food-contact articles, including cookware, containers and ceramicware

Do not rely on the HTS code alone

An HTS code is a customs classification. FDA uses its own program, product code, intended-use and compliance data. The HTS code can be useful as a screening signal, but the product description, composition, claims, intended use and regulatory status still need to be evaluated.

Examples

• A face cream may be a cosmetic, a drug, or both depending on its claims and intended use.
• A ceramic cup is not food, but it may fall within FDA's food-contact/ceramicware entry requirements.
• A laser pointer is not a medical device but is a radiation-emitting electronic product regulated by FDA.

If the regulatory status is unclear, obtain a detailed product description, ingredients/materials, label images, claims, manufacturer information and intended use before filing.

Sources

• FDA Importing FDA-Regulated Products
• FDA Food Packaging and Food Contact Substances
• FDA Importing Radiation-Emitting Electronic Products

FDA clearance and FDA compliance are not the same thing.

Entry data tells FDA what is being imported and supplies the information used for screening. It does not certify that the product is legally compliant, and FDA release is not the same as product approval.

What entry transmission does

FDA receives entry information electronically through ACE. FDA uses the submitted data together with its internal systems and risk-screening tools to determine whether the line may proceed, requires documents, should be examined or sampled, or requires further compliance review.

What product compliance covers

Depending on the product, compliance can include labelling, permitted ingredients, facility registration, product listing, premarket authorisation, performance standards, prior notice, FSVP, good manufacturing practices and other requirements.

Correctly transmitting an FDA entry cannot cure defective labelling or another underlying compliance problem.

Sources

• FDA Import Program
• FDA Importing Human Foods
• FDA Examination & Sample Collection

FDA entry requirements vary by commodity and intended use. There is no single field set that applies to every FDA-regulated product.

Common data elements

Depending on the FDA program, a regulated line may require some or all of the following:

• Detailed product description and brand
• FDA Product Code
• Country of production/origin and country of shipment
• Manufacturer or producer information
• Shipper and importer information
• FDA quantity and unit of measure
• Intended Use Code (IUC)
• Program or processing information
• Prior Notice data for covered food shipments
• Facility registration, product listing, approval or other identifiers
• Affirmations of Compliance (A of C) where applicable
• FSVP importer information for covered foods

Accuracy matters at line level

FDA uses information from each line to evaluate the imported product. Products should not be grouped together when FDA data elements differ. FDA lists incorrect intended-use codes, incorrect product codes and incorrect grouping of line items among common submission problems.

Best practice for shippers

Create and maintain an FDA master record for each SKU before the first shipment. Do not ask operations teams to reconstruct FDA data from a commercial invoice at the time of dispatch.

Sources

• FDA Common Entry Submission Errors
• FDA Transmitting Required Information
• FDA Industry Quick Reference Guide to ACE
• CBP FDA Supplemental Guide

The FDA Product Code identifies the type of regulated product being imported. It is separate from the HTS code used for customs classification.

Product Code structure

FDA Product Codes are built from five elements:

1. Industry – two characters
2. Class – one character
3. Subclass – one character
4. Process Indicator Code (PIC) – one character
5. Product – two characters

Determine the Industry first, then move through the available class, subclass/process and product choices.

Basic process

1. Open FDA's official Product Code Builder.
2. Search using the generic product name or a meaningful keyword.
3. Select the correct FDA Industry.
4. Review the available Class choices.
5. Select the Subclass and Process Indicator that accurately describe the product and process/packaging where applicable.
6. Select the final product description.
7. Compare the resulting code against the actual commercial product and invoice description.

Common mistakes

• Using an HTS code as if it were an FDA Product Code.
• Copying a code from another SKU with a different formulation, packaging or process.
• Selecting the closest-sounding description without reviewing the hierarchy.
• Choosing a code because it previously released quickly rather than because it accurately describes the goods.

Sources

• FDA Product Codes and Product Code Builder
• FDA Product Code Builder
• FDA Common Entry Submission Errors

The FDA Product Code answers approximately “what is the product?” The Intended Use Code (IUC) answers “how or why is it being imported?”

Intended Use Code

FDA explains that an IUC consists of a base code and subcode. ACE uses the selected IUC to determine which additional data elements are required. An incorrect IUC can therefore cause other required fields to be wrong or missing and can delay FDA screening.

Do not copy an IUC from another shipment unless the product and import scenario are genuinely equivalent.

Affirmations of Compliance

Affirmation of Compliance codes allow filers to transmit supporting regulatory identifiers such as registrations, listings, approvals or other compliance information where applicable. FDA states that these codes can help expedite review, but the underlying information must be accurate.

Food-contact / ceramicware example

FDA's ACE quick-reference guidance identifies IUCs as mandatory for ceramicware and other food-contact substance (CCW) products. This illustrates why a product that looks simple from a customs perspective can still require specific FDA entry logic.

Sources

• FDA Common Entry Submission Errors
• FDA Affirmation of Compliance Codes
• FDA Industry Quick Reference Guide to ACE

FDA entries can involve several different parties. These roles should not be treated as interchangeable simply because the same company sometimes performs more than one role.

Manufacturer / producer

The manufacturing or producing establishment associated with the regulated product. Program-specific registration or establishment identifiers may apply.

Shipper

The party shipping the goods. The shipper is not automatically the manufacturer.

Importer / consignee

The party used for the applicable FDA import declaration. The exact role and data requirements vary by FDA program and entry scenario.

FSVP importer

For covered food imports, the FSVP importer is a specific regulatory role. FDA describes it generally as the U.S. owner or consignee of the food at the time of entry. If there is no U.S. owner or consignee at entry, it is the U.S. agent or representative of the foreign owner/consignee who has confirmed consent in a signed statement.

FDA requires identifying information for the FSVP importer at entry, including the recognised unique facility identifier where applicable. FDA currently recognises DUNS as an acceptable UFI for FSVP.

Operational rule

Do not automatically populate every FDA party with the consignor or consignee unless the underlying regulatory role is actually satisfied by that party.

Sources

• FDA FSVP Final Rule
• FDA Transmitting Required Information
• FDA Common Entry Submission Errors

Food imports have several requirements that are separate but often encountered together. A shipment may require valid food facility registration, Prior Notice and FSVP information, in addition to compliant food and labelling.

Food facility registration

Facilities that manufacture, process, pack or hold food for consumption in the United States are generally required to register with FDA unless an exemption applies. Required food facility registrations must be renewed every other year during FDA's biennial renewal period.

Prior Notice

FDA must receive Prior Notice before covered food is imported or offered for import into the United States. Prior Notice can be transmitted as part of the customs/ACE process or through FDA's Prior Notice System Interface in applicable situations.

FSVP

The Foreign Supplier Verification Programs rule generally requires the FSVP importer to verify that the foreign supplier is producing food in a manner that meets applicable U.S. food-safety standards. Exemptions and modified requirements exist for certain products and circumstances.

Shipping checklist

• Confirm the manufacturer/facility identity.
• Confirm food facility registration where required.
• Determine who is acting as the FSVP importer and obtain the required entry data.
• Prepare Prior Notice information.
• Confirm the FDA Product Code and IUC.
• Review labels for U.S. compliance.
• Check applicable Import Alerts where risk exists.

Do not wait until the parcel reaches the U.S. to identify the FSVP importer or correct facility-registration problems.

Sources

• FDA Importing Food Products into the United States
• FDA Registration of Food Facilities
• FDA Prior Notice Guidance
• FDA FSVP Final Rule

Labeling is one of the most avoidable causes of FDA import problems. A product can be correctly declared to FDA and still be detained if its label appears to violate applicable requirements.

Common food and dietary-supplement problems

• Missing or incorrect statement of identity.
• Missing net quantity statement.
• Missing or incomplete ingredient declaration.
• Missing Nutrition Facts or Supplement Facts information, or use of an incorrect format.
• Missing name and place of business of the manufacturer, packer or distributor.
• Required information not presented in English where required.
• Claims that change the regulatory status of the product or create drug-type claims.
• Allergen or other mandatory declarations missing or incorrect.

Pre-shipment control

For higher-risk categories, request clear images of every label panel before the first shipment. A logistics company does not need to become the product's regulatory consultant, but it should avoid filing obviously incomplete or contradictory information.

Sources

• FDA Food Labeling Guide
• FDA Dietary Supplement Labeling Guide
• FDA Examination & Sample Collection

An FDA Import Alert tells FDA field personnel that certain products, manufacturers, shippers, countries/regions or other defined categories may be subject to heightened import controls. Many Import Alerts authorise Detention Without Physical Examination (DWPE).

What DWPE means

When an entry falls within the scope of an Import Alert, FDA may detain the affected product without first physically examining or sampling that shipment. The importer then has the burden of addressing the detention and providing evidence supporting admissibility.

Why logistics companies should care

A shipment can be perfectly documented from a transport perspective and still become commercially unusable if the manufacturer/product is subject to DWPE. Checking risk before dispatch can prevent avoidable storage, return, destruction and customer-service costs.

Recommended check

• Search the current FDA Import Alert database using the manufacturer, product and country.
• Read the scope of the specific alert carefully; do not assume every product from a country is affected.
• Check whether the firm or product is specifically listed where the alert contains a Red List or other listing.
• If an alert may apply, obtain regulatory advice before shipping.

Import Alerts change. Always check the current FDA database rather than relying on an old PDF, spreadsheet or prior shipment result.

Sources

• FDA Import Alerts

For regulated SKUs, maintain the requisite data in the WeiYa Customs Products database.

Workflow

1. Create or select the Customs Product for the SKU.
2. Enter the normal customs product data.
3. Add the FDA/PGA data required for that product.
4. Validate the FDA Product Code and Intended Use Code against current FDA guidance.
5. Add the appropriate regulatory parties and identifiers.
6. Save the Customs Product.
7. Record the resulting WeiYa product ID for use when creating shipments.

Data that may be required

The exact fields depend on product type. Existing WeiYa examples supplied for this project include FDA Product Code, product description, brand, country data, contact, importer, intended-use code, manufacturer, prior-notice submitter, quantity/UOM, shipper, processing code and product type.

Examples from existing WeiYa product records

• A cosmetics example uses product type COS and stores FDA Product Code and Intended Use Code together with manufacturer/importer/shipper data.
• A ceramic food-contact example uses FOO-CCW, includes processing code FOO, and stores the CCW Product Code and Intended Use Code.

Important: a saved WeiYa product record is a transmission template, not a regulatory approval. The shipper/importer remains responsible for the accuracy and compliance of the underlying product data.

Sources

• FDA Common Entry Submission Errors
• FDA Product Codes and Product Code Builder
• FDA Industry Quick Reference Guide to ACE

After a PGA-regulated product has been configured in the Customs Products database, use the resulting WeiYa product ID when creating shipments for that product. This allows the shipment to reference the maintained customs/PGA product record rather than requiring the full data set to be rebuilt for every shipment.

Before using a saved product ID

• Confirm the physical product is the same SKU/configuration represented by the saved product.
• Confirm the manufacturer and regulatory parties have not changed.
• Confirm the FDA Product Code and Intended Use Code are still appropriate.
• Confirm registration/listing/FSVP/Prior Notice information that may vary by shipment is current.
• Do not reuse a product ID for a materially different formulation, intended use, manufacturing site or FDA classification.

Shipment-level data still matters

Some FDA information is inherently shipment-specific. Prior Notice, quantities, arrival information, consignee/importer circumstances and other entry data may change even when the underlying product master is unchanged.

Sources

• FDA Common Entry Submission Errors
• FDA Transmitting Required Information

Qualified Party Model

Under U.S. postal regulations, the traditional Importer of Record structure does not apply.

WeiYa acts as the Qualified Party and bond holder. This structure centralises customs responsibility while allowing the Post to continue operating its standard postal flows

Shipment Coverage

WeiYa handles:

• Informal entries up to USD $800

• Standard postal flows

• DDP (Delivered Duty Paid) model

Shipments excluded from informal processing include:

• AD/CVD goods

• Quota-controlled goods

• Formal entry shipments

Exception workflows are defined during onboarding

Duty Methodology

WeiYa supports:

• Ad valorem duties (percentage of value)

Posts may change methodology once per calendar month with 24-hour notice

Exemptions

Certain goods remain duty-exempt, including:

• Bona fide gifts

• Informational materials

• Mail flats and documents

Pharmaceuticals are not exempt under international mail rules

Visit the fulfilment app in your WeiYa account and click Sign In. You will be redirected to the authorisation page
for the Fulfilment software. This enables the WeiYa Fulfilment application to access your account
information.

Once you sign in to the Fulfilment application, you may be prompted to enter some account and shipping configuration details.

Account Console

Company Address

The company information must relate to the entity who is acting as the shipper. The shipper is the party who actually sold the products being shipped to the customer.

Note: If you are a consolidator, you will need to use the API to assign the correct shipper to each shipment.

All information must be submitted in English.

This information can be changed at any time by going to the Account Console page which can be found by clicking on your username at the top right hand side of the screen.

Return Address

For various shipping methods, the return address can be set in your Account Console.

An order in the fulfilment app represents an order from your shop or an order you wish to ship. Order information must be submitted in English. All information should be as accurate as possible. Any inaccuracy/false declaration may result in fulfilment or shipment delays and fines which will be charged back to your account.

Order Flow

There are 6 order statuses which may be applied to an order.

Processing - EDITABLE

All orders will initially show as processing. Orders are processed every hour and moved to either Backordered or Ready depending on stock availability.

Exception - EDITABLE

Orders with a bad delivery address or unavailable routing will be moved to Exception status. The user must correct the errors before the system can process the order.

Backordered - EDITABLE

Orders where required stock is unavailable will be moved to Backorder status. Orders with the Backorder status are also processed hourly in case new stock has become available.

Ready - EDITABLE

Orders where required stock is available will be moved to the Ready status where the warehouse will electronically pick the order up for packing at least once daily.

Packing

Orders which have been electronically picked up by the warehouse for fulfilment will show as packing.

Fulfilled

Once orders have been picked, packed and shipped by the warehouse in full, the order will move to fulfilled status.

Partial

Orders that have been partially fulfilled, will show this status. Partially fulfilled orders will move between Partial and Packing until the entire order has been fulfilled.

Creating Orders

There are 4 methods of creating orders:

• Automated Shopify Import
• API integration - read more at [API documentation]
• CSV Import
• Manual Entry

Automated Shopify Import

You can easily setup a link between WeiYa Fulfilment and your Shopify store. Read more about the setup procedure here. We import orders and line items from your Shopify store that meet the below.
Orders must meet the following criteria:

• Fulfilment Status - Unshipped
• Financial Status - Paid
• Status - Open

Line items within an order will be imported if the product/SKU is set up in the WeiYa fulfilment system and matches the SKU in Shopify.

CSV Import
Orders > Import

You can import a CSV file containing your orders at your convenience. To import orders, you will need to download the template. Sample rows have been provided. Check the Import Orders page for details on mandatory and optional fields.

Manual Entry
Orders > Create an Order

Use this page to manually create an order in the fulfilment system (one-by-one). All fields marked with an * must be entered and all order information must be submitted in English.

Order Search
Orders > Search

You’re able to search through all your orders using this page. Orders are displayed with the most recent created date on top (descending chronological order). You can filter your orders by date and status, as well as search for the order by ID, Shop Order # and Shop. The total number of orders found within your criteria will be displayed and you are able to export all orders in view by clicking “Export”.

Editing and Deleting Orders

You can edit or delete an order when it is in the following statuses:

• Processing
• Exception
• Backordered
• Ready

Note: you will need to perform the same change in Shopify prior to making a change in the Fulfilment app.

Partial Fulfilment

A new feature of our system is the ability to separate fulfilments and orders. This allows orders to be fulfilled completely or in part. Each order may have 1 or more fulfilments. Each fulfilment will have its own fulfilment charge and shipping charge.

If partial fulfilment is active on an order, each Product will be checked for availability. That is, all pieces ordered for an entire Product must be available for that SKU to be sent for packing.

You can opt to have a particular order fulfilled in part at the time of order creation. You can also set all orders to have this feature turned on or off by default on a Shop by Shop basis.

Setting Shop Default

To select this option, go to Shops > Search > Options > Edit and set partial fulfilment to Yes. Once enabled all orders will have this setting enabled by default upon import. Changing this setting will not affect the orders already in the system.

Products should mirror the products that you intend to have WeiYa pick, pack and ship for your
orders.

Each product in the WeiYa system should be unique to a specific product e.g. Mens Red T Shirt Large. While the Product Name should describe the specific product, the Customs Description should describe the item; in this case, Mens T Shirt. See Description Best Practices for more information.

The SKU of a product must be unique for each Shop. If you sell the same product in multiple shops, the SKU can remain the same.

Check the Prohibited and Dangerous Goods information included in this document and make sure to keep your product database up to date as only orders that have line items matching products will be imported.

Adding Products

There are 3 methods of adding products:

• API integration - read more at [API documentation]
• CSV Import
• Manual Entry

CSV Import

Products > Import

You can import a CSV containing your products at your convenience. To import products, you will need to download the template. Sample rows have been provided. Check the Import Products page for details on mandatory and optional fields.

Manual Entry

Products > Create a Product

Use this page to manually create an product in the fulfilment system (one-by-one). All fields marked with a * must be entered and all order information must be submitted in English.

The Value must be declared in USD. This will be used when creating your shipments and declaring the value to customs in various countries and should match the sale transaction price of the items you are shipping.

A shop in the fulfilment app should represent a shop you have in the real world (online or
otherwise).

Adding Shops

There are 2 methods of creating Shops:

• API integration - read more at [API documentation]
• Manual Entry

Manual Entry

Shops > Add a Shop

When adding a shop, all fields are mandatory. The Shop ID is a short string that must be unique in our system and will be used when you add orders using the API and CSV.

The Shop Name is what you will see within the online interface and can be whatever you like!

Shopify Shops

The process for adding a Shopify shop is a little different to adding a regular Shop. To add a
Shopify Shop, you will need to “Add a Shop” and select Shopify as the Shop Type.

Once you click submit, you will be returned to the Shops list where you will see your new Shop.

Your new shop will initially show as Disconnected. To connect your shop, click on Options > Connect, and a popup will be displayed.

You’ll need to enter your Shopify shop URL and click “I Accept”. If you are not currently logged in to your Shopify store, you will be asked to log in to complete the connection. Once complete, your shop will show as Connected.

Shopify Orders

Our system will pull all new Shopify orders that meet the conditions as listed here every 4 hours.
Any changes to orders must be made both in Shopify and in Fulfilment.

Creating an Inbound Shipment

An inbound must be created for all inventory that you will be shipping to our warehouses. By creating an inbound, our warehouses will be able to receive and process your inventory efficiently. Once created, the resulting inbound label must be applied to:

• Every carton if loose
• Every pallet if palletised

Inbound label sample

To create an inbound, log in to your account and visit the fulfilment app in your WeiYa account

Product Barcodes

All items in the inbound shipment that are shipped into the WeiYa facility must have a barcode that matches the one established in your products' settings. This is for both products and product packaging. Barcodes and SKUs are treated as separate entities in WeiYa but they can also be the same value. Any items not barcoded will be charged a labelling fee and may face delay at time of inbound processing.

Delivery

The delivery address for your inbound shipment is listed on the shipment's page. You should use the country's local language when writing the address. Contact info@myweiya.com to obtain an address if one isn't available on the page.

Pick-up

If WeiYa is arranging pickup of your inventory and for larger shipments, you will also need to
provide a packing list to info@myweiya.com. Include the inbound ID in the subject of the email.

Accounts Information

Accounts for WeiYa Fulfilment are prepaid. The amount you prepay is considered your account balance. You can add funds to your account balance at anytime.

Account Balance Statement

To view your current statement, visit the Balance section of the account console where you can view a month by month breakdown of charges.

Activity which is yet to be invoiced will show as “Pending Charges”.

Adding Funds

To add balance to your account, visit the Payment section of the account console. Once a
deposit is received, your account balance will be updated automatically.

If your account has insufficient funds (less than the amount required to generate a label), no
shipments will be fulfilled. We recommend funding your account with at least 1 week’s credit to
avoid this issue.

We offer additional settings allowing third party shop owners to customise their integrations.

Service

The default shipping service for orders imported from third party shops. It will automatically downgrade during processing if the preferred service isn't available for an order.

Partial Fulfilment

Flags imported orders to be partially fulfilled in the event some of the order's line items have insufficient inventory.

Packing Slip

Flags imported orders to include a generic white label packing slip for an additional fee. Gift messages are available but must be manually added to the order.

This article will guide you through the connection and initial setup process for Shopify store owners.

Connecting your shop
Importing Orders

Connecting your shop

To connect to your Shopify store you will need to know your:

• Shopify store ID
• Shopify Login

Select an existing Shopify store or create a new one in WeiYa Fulfilment.

After clicking the "Connect" button a new window will appear prompting you to enter your Shop ID. This is the Shopify subdomain you configured when setting up your e-commerce store and looks like https://shop-id.myshopify.com/admin.

After clicking "continue" the new window will prompt you to sign into your Shopify account if your current browser session is signed out by redirecting you to Shopify's login gateway. If you're already signed in then your store will automatically connect within a few seconds.

Importing Orders

Once your store is connected your orders will begin to auto-import every hour if the following conditions are met:

Additionally, the line items you wish to import must have SKUs that match the products' SKUs you've configured in WeiYa Fulfilment. The system will ignore line items and potentially entire orders if the SKUs do not match.

For more configuration guides and troubleshooting check out:

• Third Party Shop Settings
• Why are my Shopify orders not being updated with tracking information?

Yes, a Shopify store can be connected to automate order fulfilment and providing tracking numbers. More information about this process can be found here.

There are a few changes required in order for WeiYa to fulfill orders. Here are some different steps to ensure we can push tracking information back to your Shopify store. Replace my-shop with your shop's ID.

Checkout Settings

By default Shopify will create an empty fulfilment object when an order is paid for. Ideally it's not recommended since it requires a few extra API requests to push tracking information back to Shopify. Below are steps to change the default behaviour and minimise the workload.

1. Go to your checkout settings page: https://my-shop.myshopify.com/admin/settings/checkout
2. Scroll down to the "Order Processing" section.
3. Under "After an order has been paid" option select the one that says "Do not automatically fulfill any of the order's line items".

Inventory Settings

Shopify requires all products fulfilled by a service provider to have inventory at the provider's location. If no inventory is at the service provider's location then Shopify will reject any requests to fulfill an order.

1. Go to your shops inventory page: https://my-shop.myshopify.com/admin/products/inventory
2. Select the WeiYa location from the top right dropdown menu. A WeiYa location is created in your Shopify store when it's connected to WeiYa Fulfilment for the first time. You can confirm this by visiting https://my-shop.myshopify.com/admin/settings/locations and looking under "App locations".
3. Products at our location will populate the table. Add more to the quantities if they're too low. If you don't see the product listed then you must set WeiYa as the fulfilment service provider by editing the product. Use Shopify's bulk editor to make changes to multiple products at once.

The problematic orders should be marked as fulfilled within 5 hours of making the changes unless there's another problem elsewhere in which case you should contact us.

Thank you for your interest in getting started with WeiYa Returns. With WeiYa Returns you will have a custom US return address and your returned packages will be processed for you review.

Below are the steps to get started after you have signed up for an account.

Complete your company information

Enter your company name only.

Add funds to your account.

Subscribe to WeiYa Returns.

Find your custom returns address.

Not at this time. You can create labels for reshipping returned undeliverable parcels with an updated address and bulk shipping returned parcels to your fulfilment center or warehouse.

A recurring subscription to the WeiYa Returns service will cause future returns to be processed and stored at a WeiYa facility. It also gives you the option to verify or reship the returned packages.

Adding authorised users to your account allows your colleagues to manage your operations and act on your behalf. Users you wish to add must also have a WeiYa account. Follow the steps below to add an authorised user.

1. Visit your WeiYa account.
2. Click on the "+ Add Authorised User" button.
3. Enter the email address your colleague used to sign up with on WeiYa and press enter. The page will inform you if a match is found.
4. If a match is found several permissions will appear below. Select the check box of each permission you wish to grant the user.
5. Click the "Submit" button.

Once the user is added they can login and see an option to "Switch Accounts" by clicking the power button in the top right corner of the screen as seen below.

This will lead to a page that lists all accounts this user has access to. By selecting your account they will be able to do everything you can within the scope of their permissions. They can switch back to their account the same way as before.

You can modify permissions and remove authorised users at any time.

We work with Hurricane, Avalara and Zonos to calculate duties and taxes, so landed cost can be shown at checkout and settled before delivery on DDP shipments.

If you already use one of these services, tell your account manager and we’ll connect it to your WeiYa account. For help, email info@myweiya.com.

Total Shipping Protection covers the full item value / sale price or of your parcels for theft, loss or damage during transit up to $10,000. Total Shipping Protection also covers return shipping costs for damaged parcels and re-shipping costs for stolen, lost or damaged parcels. To find out what you are and are not covered for in more detail, you can log in to your XCover Account and check your policy wording.

Total Shipping Protection doesn’t cover your goods once they arrive at their destination. For example, If your parcel is delivered successfully and is subsequently lost, damaged or stolen, it isn’t protected. Protection doesn’t extend to goods that are damaged before shipment and any duties or taxes applied to the cost of return shipping or re-shipping stolen, lost or damaged parcels are also not covered. Depending on your protection, certain goods are also excluded. To find out what you are and are not covered for in more detail, you can log in to your XCover Account and check your policy wording.

For item values below $30, your shipment is automatically protected free of charge. For shipments valued more than $30, the cost of Total Shipping Protection is set as a percent of the total order value, plus shipping cost. The fee is calculated per shipment and is returned in your quote from WeiYa and it’s also displayed when you sign up to the program.

Rates are shown in the Total Shipping Protection wording, available when you edit a shipment or when you set up Total Shipping Protection.

No, there is no excess or deductible to pay as part of this protection.

Once enabled, your Total Shipping Protection begins as soon as your parcel or parcels leave its originating address. Your parcel is covered for the duration of shipment.

Once enabled, your Total Shipping Protection ends when the parcel or parcels are delivered to the intended recipient.

Yes. Depending on your country of residence, there is a maximum limit on protection per parcel. To find out more, log in to your XCover Account and view your protection wording.

Yes. Deliveries to countries on sanction lists from the UN and United States are not covered by Total Shipping Protection.

Algeria, Angola, Benin, Botswana, Burkina Faso, Burundi, Cameroon, Cape Verde, Central African Republic, Chad, Comoros, Congo - Brazzaville, Congo - Kinshasa, Côte d’Ivoire, Djibouti, Egypt, Equatorial Guinea, Eritrea, Ethiopia, Gabon, Gambia, Ghana, Guinea, Guinea-Bissau, Kenya, Lesotho, Liberia, Libya, Madagascar, Mali, Malawi, Mauritania, Mauritius, Mayotte, Morocco, Mozambique, Namibia, Niger, Nigeria, Réunion, Rwanda, São Tomé & Príncipe, Senegal, Seychelles, Sierra Leone, Somalia, South Sudan, Sudan, Eswatini, Tanzania, Togo, Tunisia, Uganda, Western Sahara, Zambia, Zimbabwe, Afghanistan, Belarus, Bosnia & Herzegovina, Cuba, Iran, Iraq, Lebanon, Myanmar (Burma), Nicaragua, North Korea, Russia, Syria, Ukraine, Venezuela, Yemen, US & UN trade sanction countries

The following goods are not covered: Antiques, artwork and jewelry; arms, ammunition, military equipment and any similar goods which should properly be subject to the Export Control Order 2008; automobiles and motorcycles; bonds, deeds, manuscripts, securities and plans; bullion; cash and credit cards; perishable foodstuffs and other temperature sensitive goods.

XCover’s parent company Cover Genius is an insurance technology firm that has won multiple awards within the retail

and insurance industries for it’s claim handling technology.

It was ranked #1 in the Financial Times’ list of the fastest growing companies and counts eBay and Wayfair as partners.

The insurance is underwritten by Continental Insurance Company, a CNA company (CNA), Chicago, IL, and administered and sold by Cover Genius Insurance Services, LLC, a licensed agent of CNA.

You can opt-in to Total Shipping Protection in your WeiYa settings. Once opted in, XCover Protection is automatically applied to all shipments.

To view your documents, wording and invoice, you first need to login to your XCover account. If this is your first time logging in to your XCover Account, you first need to find the confirmation email from XCover.com and click the link to set up your XCover Account. Make sure you check your spam folder if you can’t find your confirmation email in your emails. Once you have set-up your XCover Account, you can view your documents and start a claim. We don’t post these documents via mail.

It might take an hour or two to receive your confirmation via email. Keep an eye on the inbox for the email address associated with your account in case it’s just delayed. Also check your spam, promotions or social folder in your email just in case. If you still don’t have a confirmation email after several hours have passed, feel free to reach out for help.

You can change your Total Shipping Protection settings in your WeiYa account. Once opted in, XCover Protection is automatically applied to all shipments. You can opt-out of your Total Shipping Protection any time before the parcel leaves the originating address for a full refund. If you cancel your Total Shipping Protection when the parcel is en-route, you may no longer be eligible for a refund. When you cancel your XCover Protection we process your refund instantly, although it may take up to 7 days for the refund to show on your card statement.

You cannot modify your Total Shipping Protection.

Once approved, we process refunds immediately but funds may take between 2 and 25 days to be available in your account. At any time we encourage you to speak to your card issuer for an update.

It’s quick and hassle-free to make a claim. You can submit a claim via your WeiYa account or visit xcover.com/claim and you’ll be guided through the submission process. It’ll be picked up by our friendly claims team who aim to complete 95% of claims within 3 days. Keep an eye on your emails for further instructions once you’ve lodged your claim.

To help us assess your claim as quickly as possible we may ask you - depending on the nature and amount of the claim - to share as much information with us as possible, such as:

• A detailed description of what happened
• For damaged parcels, photo or video evidence of the damage
• For stolen parcels, we may require a copy of any written communications with the carrier
• Videos such as surveillance footage
• A police report for stolen items
• Any other supporting documents

There is no need to wait to submit a claim for Total Shipping Protection. You can lodge a claim at any time after the parcel has left your premises. We typically finalise claims once the parcel status is confirmed.

To use OAuth 2.0 in your application, you need an OAuth 2.0 Client ID, which your application uses when requesting an access token or identity token.

To create an OAuth 2.0 client in your account:

1. Go to the Developer Console.
2. From the clients list you can create a new one.
3. Enter the name of your application. This name is visible to users.
4. Enter the website for your application. This website is visible to users.
5. Enter the Redirect URI for your application. This is where the user will be redirected to after accepting or declining the requested permissions during the consent process. It can include query or fragment parameters but the Host name must match the "redirect_uri" Host name in the authorisation request.
6. Enter the support email for your application. This email is visible to users. This email will also be used for important updates from WeiYa.
7. Choose the Permissions you are requesting from the user.
8. Press 'Submit'.

If successful you will be taken to a confirmation page that displays the Client ID, Secret, Public and Private Keys. The Secret and Private Key must be securely saved. They will not be displayed again. Learn how to Request Authorisation From a WeiYa Account.

You may create up to two clients in your account. You can delete clients by deactivating them first. The client will remain queued for deletion for 30 days.

The permissions or scope of the OAuth 2.0 client determine the user details and resources the application can access and modify. There are two types important groups of permissions that correspond with the type of token generated after authorisation. The tokens issued to your application depend on the requested response_type and client permission settings. This article discusses the permissions. For information about the authorisation parameters see how to make your first request.

Open ID Connect (ID Token)

The "openid profile email" permission generates an id_token that has details or claims about a user encoded in the token itself. These details are publicly viewable but the token is signed with your client's Private Key so you can verify the authenticity by decoding the token with your client's Public Key. The types of claims available in the decoded token are:

API (Access Token)

The remaining permissions from the list affect which API resources your application can access and modify. Some resources like Warehouses and Entry Points are always accessible. The individual permission names on the client settings page provide some insight into what each one does. Having "write" access allows an application to create, update, and delete resources.

The access_token that is generated will not have all of the same claims encoded as the id_token. The types of claims available in the decoded token are:

Consent Screen

The consent screen a user sees when authorising your application will be different depending on the permissions requested. This screen will appear when requesting permissions for both groups:

Changing your client's permissions causes users to authorise your application again - even if you're downgrading the scope. It will not invalidate existing tokens.

OAuth 2.0 clients have an ID and Secret that are used during authentication while creating an Access Token or revoking a connection. A client secret should be treated like a password and kept in a secure location. You may create a new secret at any time in case you forgot/lost it or you believe it may have been compromised. Refer to Request Authorisation From a WeiYa Account to see how the credentials are used.

WeiYa will never ask for your secret or private key.

This article will demonstrate how to create an Access Token and ID Token for an authenticated user that authorises your application. You will need an OAuth 2.0 client before starting. See Setting up an OAuth 2.0 Client.

Authorisation Endpoint

Users must authorise your client before you can receive a token. To do this you must construct a URI with several required and optional parameters that instructs the Authorisation Server on how to handle the response.

The scopes are defined in the client settings and inherited by the request. Clients that change their scopes will force users to re-authorise their application.

An example request to the Authorisation Server might look like this:

GET https://[account-host]/auth/v1/authorise?client_id=10000000001663771051&response_mode=query&response_type=code&redirect_uri=https://www.myapp.com/auth?provider=weiya&state=sddb213213

The user will be prompted to sign in before consenting if they're not already signed in. If the user has previously authorised your application then it will skip the consent screen and immediately redirect the user back to the specified redirect_uri.

Response Types

The response_type instructs the Authorisation Server to generate one, both, or no tokens at all. It can also affect the authorisation flow by requiring an extra step. Several response types are supported and described below.

code

The "code" response type requires an additional HTTP request-response after authorisation. Once the user has consented they will be redirected to your application with a code in the query parameters. This code expires after 10 minutes and is a random string that's used for retrieving the tokens:

https://www.myapp.com?state=&code=8de3a284c25392b474b453b6068e00f1e4f0b617

Your application's backend must make an additional request to the Token endpoint with this code in the request body:

POST https://[account-host]/auth/v1/token Content-Type: application/x-www-form-urlencoded Authorisation: Basic base64encode({client_id}:{client_secret}) grant_type=authorisation_code code=8de3a284c25392b474b453b6068e00f1e4f0b617 redirect_uri=https://www.myapp.com/auth?provider=weiya

The "Authorisation" header must be "Basic" and include the base64 encoded and concatenated Client ID and Client Secret. The redirect_uri must match what was originally sent at the start of the authorisation process.

A successful response will look similar to the below:

{ "token_type": "Bearer", "id_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImFkODQ3YjJkZTNmMTY1NjFlMDg3MDJhNjY2Mjc1MWMzOGVlODc0ZjcifQ.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjkwMDEiLCJhdWQiOiIxMDAwMDAwMDAwMTY2NDM0NTY5MiIsImlhdCI6MTY2NDkxMjY1MCwiZXhwIjoxNjY1NTE3NDUwLCJlbWFpbCI6Imp1c3RpbkBib3hjLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmFtaWx5X25hbWUiOiJQb3BlIiwiZ2l2ZW5fbmFtZSI6Ikp1c3RpbiIsIm5hbWUiOiJKdXN0aW4gUG9wZSIsImxvY2FsZSI6ImVuIiwic3ViIjoiMSIsInpvbmVpbmZvIjoiQW1lcmljYS9OZXdfWW9yayJ9.T9C6Ik5gdVd7faTxmXy6q7s1sSnxNOVvMTXEFryii8ADFZsHL7SoDEj_9nGFrBq1mo5ra3mK9q7vr7gzk1NxJouHYjVVcO_CFKRK13Tj962_Tx7XiPlRe0eXDpIabT5HbfegI4P9ksiLBY8i79Z1PRmaTsjgy6cOJhkIz0gJOjeJmwMV6U5XwBAbFkmya6an2wujD7bJdJ7R_IZVWP8czdo779NYHhJ8cV-VdXKkpIW0HvPGBH_ZHFg3NE4TzSumdGVhohucKBCRnOoGAI5sEao0yLI01ZrsIqzdoxmWJvg75UM6JBVmvq5CGCWj0rVorSEaP639lM89W_fxrJaT3w", "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImFkODQ3YjJkZTNmMTY1NjFlMDg3MDJhNjY2Mjc1MWMzOGVlODc0ZjcifQ.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjkwMDEiLCJpYXQiOjE2NjQ5MTI2NTcsImV4cCI6MTk4MDI3MjY1NywiYXVkIjoiaHR0cDovL2xvY2FsaG9zdDoxMDAwMCIsInN1YiI6IjEiLCJjbGllbnRfaWQiOiIxMDAwMDAwMDAwMTY2NDM0NTY5MiIsInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwifQ.QyiHKRLI8J8Kmb2lR4m53BaiOJrpm1JaRUrYCnatuJbamXQKsURwyUbCD1zSYIKCLVmafmIlQFx_CwUNg7ocplQVbJ-Bg9XlY3z2WFZbdM19i1ufgtCz854sfd6dUMbmaa-DQEtBMNC6pSOtfm_SQFkIg8gHxTvlV-TjJf6HhvtcBfkZD8WAHQ1ifK2KZ4W-cPEqj_hy62rxBN_u0RrJt4AYaUEyPLI_0qt2ta3HfPBg4Ef2VoNEE1alIDoyl_Sxruk0RRNV3FUoeoaexc4dRwxEp3q-sTXhj4fA3g7qjoo5-K8mzwQAogjqmy0aDcbpyBy9B4nFU5GWT_A9-yVtZA", "expires_in": 315360000 }

The expires_in is the TTL of the Access Token.

token

The "token" response type generates just the Access Token and redirects the user to the application with the token in the URI.

id_token

The "id_token" response type generates just the ID Token and redirects the user back to the application with the token in the URI. The "openid" permission is required for ID Tokens.

GET https://[account-host]/auth/v1/authorise?client_id=10000000001663771051&response_mode=query&response_type=id_token&redirect_uri=https://www.myapp.com/auth?provider=weiya&state=sddb213213

The user will be asked to login before authorising the client. They will then be sent to your redirect_uri by the Authorisation Server with the id_token in the query like below:

GET https://www.myapp.com?state=sddb213213&id_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImFkODQ3YjJkZTNmMTY1NjFlMDg3MDJhNjY2Mjc1MWMzOGVlODc0ZjcifQ.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjkwMDEiLCJhdWQiOiIxMDAwMDAwMDAwMTY2NDM0NTY5MiIsImlhdCI6MTY2NDkxMjY1MCwiZXhwIjoxNjY1NTE3NDUwLCJlbWFpbCI6Imp1c3RpbkBib3hjLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmFtaWx5X25hbWUiOiJQb3BlIiwiZ2l2ZW5fbmFtZSI6Ikp1c3RpbiIsIm5hbWUiOiJKdXN0aW4gUG9wZSIsImxvY2FsZSI6ImVuIiwic3ViIjoiMSIsInpvbmVpbmZvIjoiQW1lcmljYS9OZXdfWW9yayJ9.T9C6Ik5gdVd7faTxmXy6q7s1sSnxNOVvMTXEFryii8ADFZsHL7SoDEj_9nGFrBq1mo5ra3mK9q7vr7gzk1NxJouHYjVVcO_CFKRK13Tj962_Tx7XiPlRe0eXDpIabT5HbfegI4P9ksiLBY8i79Z1PRmaTsjgy6cOJhkIz0gJOjeJmwMV6U5XwBAbFkmya6an2wujD7bJdJ7R_IZVWP8czdo779NYHhJ8cV-VdXKkpIW0HvPGBH_ZHFg3NE4TzSumdGVhohucKBCRnOoGAI5sEao0yLI01ZrsIqzdoxmWJvg75UM6JBVmvq5CGCWj0rVorSEaP639lM89W_fxrJaT3w&token_type=Bearer&expires_in=604800

Your client must verify the signature of the JWT when decoding the token to prove it is authentic and was signed with your Private Key.

id_token token

The "id_token token" response type generates both tokens and redirects the user back to the application with the tokens in the URI similar to "id_token".

none

The "none" response type does not create tokens but it does create a user-client connection meaning users don't need to reauthorise the client next time.

Errors

You may encounter different types of errors during the Authorisation process. If an error is triggered then the user will be redirected to the client's redirect_uri as long as it's valid and matches the client setting. Otherwise, the error will be displayed at the Authorisation Server. For scenarios where the user is redirected an error and error_description are returned to the client in the URI as query or fragment parameters. The error_description will help you determine the problem with the authorisation request.

All OAuth 2.0 have a pair of Public and Private keys for verifying and signing the Access Tokens and ID Tokens. These keys are created by WeiYa and can be regenerated at any point in the future. The private key must be kept secret at all times. Your client will likely never use the private key because you only need the public key for decoding and verifying the signature of the tokens.

Key ID

The Key ID is a SHA1 hash of the private key. It appears in the JWT header as kid and can be viewed on the client management page. A new Key ID will be shown only when the keys are regenerated.

Invalidating Access Tokens

You have the capability to invalidate all previously created access tokens by generating a new pair of keys. This means the API will return access denied errors if you try using an access token that was generated with the old private key because the public key is now invalid. This is useful if you believe there was a security breach in your system. WeiYa does not store access tokens so it is the client's responsibility to generate access tokens with the new private key.

WeiYa will never ask for your encryption keys.

Postal Delivered Duty Paid (pDDP)

WeiYa provides a turnkey PDDP for postal shipments. Services are being developed for a range of destinations and various integration options are available to suit.

Commercial Structure

• No setup fees

• No monthly minimums

• Weekly invoicing cycle

United States

U.S. CBP Qualified Party and related services:

• Duty and tax remittance to CBP

• Continuous customs bond coverage

• Landed cost and HS classification

• Duty verification system

• Weekly invoicing and reporting

• Qualified party filing up to US$800

WeiYa is responsible for:

• CBP notification and compliance filing

• Validation of calculated duty & remittance

• Bond coverage

• Reporting and reconciliation

The Post remains responsible for:

• Accurate product descriptions

• Correct declared values

• Correct country of origin

• Transmission of complete data

• Transportation to destination

Invoicing

Invoices are posted automatically to your account each Monday for all activity during the prior week. An email including the invoice PDF is sent to the primary account holder and a CSV back up file showing each row of data can be downloaded online in your account under the Invoices tab of the account console.

Account Balance

To view your current account balance, visit the Dashboard section of your account console. Individual transactions can be viewed on the Transactions page under the Billing tab of the acocunt console.

Adding Funds

To view payment options for your account, visit the Payment section of the account console. If remitting payment via wire transfer we suggest emailing a copy of your banking institution wire transfer slip to info@myweiya.com. Once a deposit is confirmed as received, your account balance will be updated automatically to reflect the payment.

Overview

IPC’s Postal Delivered Duties Prepaid (PDDP) framework enables postal operators to transmit Electronic Advance Data (ITMATT) through established postal messaging channels for outbound items.

Through direct integration with this framework, WeiYa processes the transmitted data to perform U.S. duty calculations and execute remittance to U.S. Customs and Border Protection (CBP) under our Qualified Party authorisation. This approach allows Posts to satisfy U.S. duty prepayment requirements using their existing postal systems, without the need to build separate customs calculation or payment systems.

For operators already using IPC messaging standards, activation of U.S. duty compliance is an extension of current workflows rather than a system overhaul. For those not yet participating, WeiYa provides a structured pathway to adopt a compliant Delivered Duty Paid (DDP) model built on established international postal data standards, ensuring operational continuity and regulatory alignment.

For more information on connecting using IPC to WeiYa, get in touch with your WeiYa account representative.

Overview

PTC's Landed Cost framework enables postal operators to transmit requisite shipment data directly via the Customs Declaration System (CDS) to WeiYa.

Through direct integration with this framework, WeiYa processes the transmitted data to perform U.S. duty calculations and execute remittance to U.S. Customs and Border Protection (CBP) under our Qualified Party authorisation. This approach allows Posts to satisfy U.S. duty prepayment requirements using their existing postal systems, without the need to build separate customs calculation or payment systems.

For operators already using PTC messaging standards, activation of U.S. duty compliance is an extension of current workflows rather than a system overhaul.

Integration

Only certain versions of CDS are supported by the PTC for Landed Cost functionality. You will need to confirm which implementation and version of CDS is running in order to determine whether you will be able to use the available tools.

Self Hosted Application

For those self-hosting CDS, Landed Cost is currently supported in versions from 2025 onwards. A patch may be required in order to add WeiYa into your integration; this can be requested from your WeiYa account representative or by directly reaching out to your PTC contacts.

Hosted and Cloud Application

The Landed Cost module is already natively supported. No further action is required on your part to activate Landed Cost.

Configuration

Once logged in to CDS, select Manage organisation preferences and navigate to Landed Cost Provider.

Select BOX - WeiYa. You will be prompted to enter your Landed Cost Token. The token can be retrieved from within your WeiYa account or by contacting your WeiYa account representative.

Click on Test connection and if you have received a success message, you have successfully connected your account to the WeiYa service.

There are some configuration options that your PTC contacts can discuss with you.

This article outlines the steps required to generate an access token for yourself when you don't need a user to authorise your OAuth Client.

1. Complete your company profile in account settings.
2. Create an OAuth Client.
   1. Enter a name for your client.
   2. The fields for Website, Redirect URI, and E-mail are not important for clients that wish to generate an access token for personal use but are still required fields.
   3. Select the "openid profile email" scope listed under Permissions.
   4. Click Submit.
3. Copy your Client ID (client_id) and Client Secret (client_secret). You can generate a new secret in the future.
4. Open Postman, Terminal, or some other command line application and follow the steps below.

Postman

cURL (Terminal / Command Line)

Copy the cURL command below.

curl --location 'https://[account-host]/auth/v1/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorisation: {{auth}}' \ --data-urlencode 'grant_type=client_credentials'

Replace {{auth}} with your client_id and client_secret and Base64 encode it. For example:

base64(client_id + ":" + client_secret)

An access token will be returned if the request was successful.

For more technical information regarding our API and the authorisation flow see our documentation.