API Partner 0.0.23

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

Resources

label

Operations

Method and Path Description
GET /partners/:partner/labels
POST /partners/:partner/labels
GET /partners/:partner/labels/: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

partner_return

Operations

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

Headers

No headers

Imports

http://www.apidoc.me/flow/common/latest/service.json
http://www.apidoc.me/flow/error/latest/service.json
http://www.apidoc.me/flow/fulfillment/latest/service.json
http://www.apidoc.me/flow/label/latest/service.json
http://www.apidoc.me/flow/return/latest/service.json

Enums

No enums

Models

label

Example Json: Minimal | Full
Field Type Required? Default Description
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.3.36 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.3.41 Yes -

Destination contact information and structured address

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.3.41 Yes -

Origin contact information and structured address

service partner_service_reference Yes -

Carrier service level used for generation and shipment of this label

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

Estimated date range until delivery

zpl string No -

Base64 encoded ZPL2-formatted data of the shipping label

pdf string No -

Pre-signed URL containing PDF copy of the shipping label

png string No -

Pre-signed URL containing PNG copy of the shipping label

commercial_invoice string No -

URL containing generated PDF commercial invoice required for international shipments

label_form

Example Json: Minimal | Full
Field Type Required? Default Description
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.3.41 Yes -

Destination contact information and structured address

order_number string Yes -

Client organization order number for the shipment

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

Origin contact information and structured address

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

Package that is part of this label request.

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.

partner_order_identifier

Example Json: Minimal | Full

Represents alternate numbers with which to identify an order.

Field Type Required? Default Description
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
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
order_number string Yes -

partner_order_reference

Example Json: Minimal | Full
Field Type Required? Default Description
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
id string Yes -

Globally unique identifier

partner_reference

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

Globally unique identifier

partner_return

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

Human-readable F12 number

organization partner_organization_reference Yes -

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

key string Yes -

items [io.flow.return.v0.models.return_line_item:0.3.36] Yes -

Minimum: 1

labels [io.flow.label.v0.models.shipping_label:0.3.36] Yes -

partner_return_form

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

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

items [io.flow.return.v0.models.return_line_item:0.3.36] Yes -

Minimum: 1

service string No -

Service level to use for return package. If not specified, will default to FASTEST service level in reverse logistics tier of the order’s experience.

destination io.flow.fulfillment.v0.models.shipping_address:0.3.41 No -

Destination of the return. If not provided, will default to calculated destination based on original location of the product and carrier service level.

key string No -

Organization’s internal identifier for this return. If one is not available or provided, Flow will generate.

origin io.flow.fulfillment.v0.models.shipping_address:0.3.41 No -

Origin address of the return. If not provided, will default to destination address of the original order.

partner_service_reference

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

Globally unique identifier

Unions

No unions