API Partner 0.0.62

Partner API provides models and resources to interact with Flow to generate shipping labels

Resources

io.flow.label.v0.models.shipping_label

Full passthrough of label request, validating that a partner is authorized to access the specified organization.

Operations

Method and Path Description
GET /partners/:partner/organizations/:organization_id/labels
POST /partners/:partner/organizations/:organization_id/labels

io.flow.label.v0.models.shipping_notification

Full passthrough of notification request, validating that a partner is authorized to access the specified organization.

Operations

Method and Path Description
POST /partners/:partner/organizations/:organization_id/shipping-notifications
PUT /partners/:partner/organizations/:organization_id/shipping-notifications/:key

io.flow.return.v0.models.return

Operations

Method and Path Description
GET /partners/:partner/organizations/:organization_id/returns
POST /partners/:partner/organizations/:organization_id/returns
GET /partners/:partner/organizations/:organization_id/returns/:id

label

Operations

Method and Path Description
GET /partners/:partner/labels
POST /partners/:partner/labels

partner_fulfillment

Used to track and manage the fulfillment of an order.

Operations

Method and Path Description
GET /partners/:partner/organizations/:organization/orders/:number/fulfillments
PUT /partners/:partner/organizations/:organization/orders/:number/fulfillments/cancellations
PUT /partners/:partner/organizations/:organization/orders/:number/fulfillments/complete/cancellations

partner_manifest

Represents closeout of a group of labels that have been transfered to the carrier for shipping

Operations

Method and Path Description
GET /partners/:partner/organizations/:organization_id/manifests
POST /partners/:partner/organizations/:organization_id/manifests

Generate a new manifest/carrier BOL with specific tracking numbers

GET /partners/:partner/organizations/:organization_id/manifests/services/:service/outstanding

Generates a new manifest with all outstanding labels and redirects to a downloadable PDF of carrier-generated manifest or bill of lading (BOL). If no outstanding labels, this will generate a 422 error.

GET /partners/:partner/organizations/:organization_id/manifests/:id

partner_order_identifier

Represents alternate numbers with which to identify an order.

Operations

Method and Path Description
GET /partners/:partner/organizations/:organization/order-identifiers
POST /partners/:partner/organizations/:organization/order-identifiers
GET /partners/:partner/organizations/:organization/order-identifiers/:number
PUT /partners/:partner/organizations/:organization/order-identifiers/:number
DELETE /partners/:partner/organizations/:organization/order-identifiers/:number

Headers

No headers

Imports

https://app.apibuilder.io/flow/common/latest/service.json
https://app.apibuilder.io/flow/error/latest/service.json
https://app.apibuilder.io/flow/experience/latest/service.json
https://app.apibuilder.io/flow/fulfillment/latest/service.json
https://app.apibuilder.io/flow/label/latest/service.json
https://app.apibuilder.io/flow/order-management/latest/service.json
https://app.apibuilder.io/flow/permission/latest/service.json
https://app.apibuilder.io/flow/return/latest/service.json

Enums

No enums

Models

detailed_label_form

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
organization string Yes -

Flow-issued ID of client organization whom partner is generating label on behalf

destination io.flow.fulfillment.v0.models.shipping_address:0.8.48 Yes -

Destination contact information and structured address

personal_data

consumer

order_number string Yes -

Client organization order number for the shipment

origin io.flow.fulfillment.v0.models.shipping_address:0.8.48 Yes -

Origin contact information and structured address

personal_data

consumer

package io.flow.label.v0.models.shipping_label_package:0.8.41 Yes -

Package that is part of this label request.

personal_data

consumer

service string No -

Desired carrier service level to use for this label. If not provided, this will default to the delivery option that Flow calculated for the order.

references [string] No -

Other reference information. These will be provided to carriers as references on the generated label.

label

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

organization partner_organization_reference Yes -

Flow-issued ID of client organization whom partner is generating label on behalf

order_number string Yes -

Client organization order number for the shipment

package io.flow.label.v0.models.shipping_label_package:0.8.41 Yes -

Package that is part of this label request.

carrier_tracking_number string Yes -

Carrier-issued or generated tracking number of the first carrier taking hold of the package

carrier_tracking_number_url string Yes -

destination io.flow.fulfillment.v0.models.shipping_address:0.8.48 Yes -

Destination contact information and structured address

personal_data

consumer

flow_tracking_number string Yes -

Flow-generated tracking number. 13 digit tracking number that begins with F70.

flow_tracking_number_url string Yes -

origin io.flow.fulfillment.v0.models.shipping_address:0.8.48 Yes -

Origin contact information and structured address

personal_data

consumer

service io.flow.fulfillment.v0.models.service_summary:0.8.48 Yes -

Carrier service level used for generation and shipment of this label

window io.flow.common.v0.models.datetime_range:0.8.46 Yes -

Estimated date range until delivery

zpl string No -

Base64 encoded ZPL2-formatted data of the shipping label

personal_data

consumer

pdf string No -

Pre-signed URL containing PDF copy of the shipping label

personal_data

consumer

png string No -

Pre-signed URL containing PNG copy of the shipping label

personal_data

consumer

commercial_invoice string No -

URL containing generated PDF commercial invoice required for international shipments

personal_data

consumer

references [string] No -

Other reference information. These will be provided to carriers as references on the generated label.

label io.flow.label.v0.models.shipping_label_document:0.8.41 No -

Contains all the output documents for the shipping label

personal_data

consumer

invoice io.flow.label.v0.models.shipping_label_document:0.8.41 No -

Contains all the output documents for the commercial invoice

personal_data

consumer

cost io.flow.common.v0.models.price:0.8.46 No -

Estimated shipping cost of the shipment.

shipment_recipient io.flow.label.v0.enums.shipment_recipient:0.8.41 No -

partner_fulfillment

Example Json: Minimal | Full

Used to track and manage the fulfillment of an order.

Field Type Required? Default Description Annotations
organization string Yes -

Flow-issued ID of client organization on whose behalf a partner is fulfilling

key string Yes -

Unique key identifying this fulfillment.

number string Yes -

Order number

items [io.flow.order.management.v0.models.fulfillment_item:0.7.61] Yes -

Items as modeled on an order.

center [io.flow.fulfillment.v0.models.center_summary:0.8.48] No -

The fulfillment center we expect this order to be fulfilled from.

partner_fulfillment_cancellation_form

Example Json: Minimal | Full

Changing an order for the purpose of cancelling specific line quantities

Field Type Required? Default Description Annotations
change_source io.flow.order.management.v0.enums.order_change_source:0.7.61 Yes fulfillment

The original source of this update, regardless of who is submitting it to Flow. This can control which parties are notified of a change.

reason io.flow.order.management.v0.enums.cancel_reason:0.7.61 Yes -

Reason for the cancellation.

lines [io.flow.order.management.v0.models.fulfillment_line_cancel_form:0.7.61] Yes -

partner_fulfillment_complete_cancellation_form

Example Json: Minimal | Full

Changing an order for the purpose of completely cancelling all remaining uncancelled, unshipped lines of an order.

Field Type Required? Default Description Annotations
change_source io.flow.order.management.v0.enums.order_change_source:0.7.61 Yes fulfillment

The original source of this update, regardless of who is submitting it to Flow. This can control which parties are notified of a change.

reason io.flow.order.management.v0.enums.cancel_reason:0.7.61 Yes -

Reason for the cancellation.

partner_manifest

Example Json: Minimal | Full

Represents closeout of a group of labels that have been transfered to the carrier for shipping

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

organization partner_organization_reference Yes -

Flow-issued ID of client organization whom partner is generating label on behalf

service io.flow.fulfillment.v0.models.service_summary:0.8.48 No -

Carrier service level used for generation and shipment of this label

Example: ups-ground, dhl-express-worldwide

timestamp date-time-iso8601 Yes -

shipping_labels [io.flow.label.v0.models.shipping_label_summary:0.8.41] Yes -

Labels that are part of this manifest

personal_data

consumer

pdf string No -

URL where to download generated manifest confirmation or bill of lading, if the service requires one be generated for pickup.

personal_data

consumer

partner_manifest_form

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
tracking_numbers [string] Yes -

service string No -

Example: dhl-express-worldwide

partner_order_identifier

Example Json: Minimal | Full

Represents alternate numbers with which to identify an order.

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

organization partner_organization_reference Yes -

Refers to your organization’s account identifier

order partner_order_reference Yes -

number string Yes -

Client’s unique identifier for this object

partner_order_identifier_form

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
number string Yes -

Client’s unique identifier for this object

order_number string Yes -

partner_order_identifier_put_form

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
order_number string Yes -

partner_order_reference

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

number string Yes -

Client’s unique identifier for this object

partner_organization_reference

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

summary_label_form

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
organization string Yes -

Flow-issued ID of client organization whom partner is generating label on behalf

order_number string Yes -

Client organization order number for the shipment

package io.flow.label.v0.models.shipping_label_package:0.8.41 Yes -

Package that is part of this label request.

personal_data

consumer

Unions

label_form

  • Type discriminator: discriminator

Different models for forms to create shipping labels in the Partner API

Type Discriminator Value Example Json Description
detailed_label_form detailed_label_form (Default) Minimal | Full

summary_label_form summary_label_form Minimal | Full

Annotations

personal_data

Identifies a field that contains Personal Data, as defined by GDPR. By default, any field marked with this annotation will be kept for 1 year and will be purgeable upon request provided there are no incomplete business activities associated with it.

consumer

Identifies a field that contains data about a consumer [as opposed to an employee of Flow, an organization or a partner].