Work in Progress.

This page is automatically generated from the FabEngine Python package library source code. As we are working to develop and document FabEngine, this page will keep growing.

Contents of this page

The fabengine.fulfillment Package

The `fabengine.fulfillment` Package¶

Functions in `fabengine.fulfillment`¶

Fulfillment functions.

class fabengine.fulfillment.Address(name, company, street, city, state, postcode, country)¶

Bases: builtins.object

Represents a postal address.

Parameters:

Parameters:	name (string) – The first line of the address label, usually contains the name of the recipient company (string) – The company name of the recipient street (string) – Street name and house numbers of the address. For countries where street names are not used, enter whatever is commonly written after recipient name and company. city (string) – The city of the address. Leave out the postal code and state, these have separate fields. state (string) – If the address is for a country where states are part of postal addresses, enter the state in the commonly used format for addresses. For the USA, use the two letter state abbreviation. postcode (string) – This is the postcode or ZIP code of the address. Enter in the format commonly used for addresses in the respective country. Some countries have numerical postcodes, others alphanumeric. Do not include the state or city name in this parameter, these have their own fields. country (string) – The name of the country the address is in. Enter this in an internationally recognized format in Western writing (preferable ASCII leaving out any accents). Postal carriers usually accept English or French country names. You can also use ISO 3166-1 country codes which will be converted into the country name when printing the shipping label.

name (string) – The first line of the address label, usually contains the name of the recipient
company (string) – The company name of the recipient
street (string) – Street name and house numbers of the address. For countries where street names are not used, enter whatever is commonly written after recipient name and company.
city (string) – The city of the address. Leave out the postal code and state, these have separate fields.
state (string) – If the address is for a country where states are part of postal addresses, enter the state in the commonly used format for addresses. For the USA, use the two letter state abbreviation.
postcode (string) – This is the postcode or ZIP code of the address. Enter in the format commonly used for addresses in the respective country. Some countries have numerical postcodes, others alphanumeric. Do not include the state or city name in this parameter, these have their own fields.
country (string) – The name of the country the address is in. Enter this in an internationally recognized format in Western writing (preferable ASCII leaving out any accents). Postal carriers usually accept English or French country names. You can also use ISO 3166-1 country codes which will be converted into the country name when printing the shipping label.

fabengine.fulfillment.ship(method, address, returnAddress=None)¶

Ships an item via a postal carrier.

Code example:

fabengine.fulfillment.ship (
  content = shippingEnvelope,
  method = fabengine.fulfillment.shippingmethods.UPSSecondDayAir,
  address = fabengine.fulfillment.Address (
      name = "Chuck Norris",
      street = "1600 Pennsylvania Avenue",
      city = "Washington",
      state = "DC"
      postcode = "20500"
    ),
  returnAdress = fabengine.fulfillment.Address (
      name = "Q",
      street = "85 Vauxhall Cross",
      city = "London",
      postcode = "SE1 1BD",
      country = "United Kingdom"
    )
)

Parameters:	content (fabengine.objects.FabEngineObject) – What are we shipping? method (fabengine.fulfillment.shippingmethods.ShippingMethod) – Shipping method used for shipping address (fabengine.fulfillment.Address) – Destination address
Returns:	An object representing the shipped package which included the tracking number if one exists.
Return type:	fabengine.objects.ShippedObject

The `shippingmethods` Module¶

The fabengine.fulfillment.shippingmethods module contains classes for every shipping methods available in FabEngine. Instances of these classes are valid method parameters for the fabengine.fulfillment.ship() function.

class fabengine.fulfillment.shippingmethods.ShippingMethod¶

Bases: builtins.object

This is the base class from which all real shipping methods are derived. You should never need to instantiate this class (instead use one of the classes derived from it), but it is listed in the documentation for completeness.