Retrieve Pick

Beta
GET/v1/operations/picks/{id}

This endpoint is idempotent. Learn more

Returns a pick by ID.

Permissions requiredValues:picks:read
The role behind your API key or agent must grant every one of these permissions.
idstring

Pick ID.

include[]optional arrayenumValues:customercreated_byfreight

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Pick ID.

objectstringenumValues:pick

Resource type identifier.

numberstring

Human-readable number that identifies the pick, distinct from the id.

customer_purchase_order_numberstringnullable

The customer's own purchase order number for the sales order this pick fulfills.

notestringnullable

Free-form note carried from the sales order this pick fulfills.

customercustomerExpandablenullable

The customer associated with the sales order.

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

The customer's business name, as shown throughout the app and on documents.

numberstring

Human-readable customer number used to identify the account, distinct from the id.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

  • normal: standard account with no restrictions.
  • preferred: account flagged for prioritized handling.
  • hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
  • hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

edi_statusstringenumValues:enableddisabled

Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and documents with this customer.

relationship_typestringenumValues:standaloneparentchild

The customer's position in the account hierarchy.

  • standalone: no parent or child accounts.
  • parent: has one or more child accounts (see child_accounts).
  • child: belongs to a parent account (see parent_account).
commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to this customer's orders.

  • commission_exempt: this customer's orders are exempt from sales commission.
  • commission_applied: sales commission is calculated on this customer's orders.

The customer counts as exempt if this field, its type group, or any of its price_groups is commission_exempt. Exempt customers never have a sales rep assigned automatically when an order is created without one.

notestringnullable

Free-form note about the customer.

credit_limitquantitynullable

Maximum credit extended to this customer.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

Always returned as null in this endpoint.
contact_infocustomer_contact_infonullable

General contact details for the customer's business.

Always returned as null in this endpoint.
freight_preferencescustomer_freight_preferencesnullable

Freight and carrier preferences applied to this customer's shipments.

Always returned as null in this endpoint.
defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

Always returned as null in this endpoint.
notification_preferencescustomer_notification_preferencesnullable

Which document emails this customer is set up to receive.

Always returned as null in this endpoint.
bill_to_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.
ship_to_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.
typeaccount_groupnullable

The account group of type type_group that categorizes this customer (for example "Distributors").

Always returned as null in this endpoint.
price_groupslistnullable

Account groups of type pricing_group that this customer belongs to, used to apply pricing rules.

Always returned as null in this endpoint.
parent_accountcustomernullable

The customer this account belongs to, when it is a child account.

Always returned as null in this endpoint.
child_accountslistnullable

The customers belonging to this account, when it is a parent account.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_bycreated_byExpandablenullable

Who created the sales order this pick fulfills, and their relation (internal/customer/system).

objectstringenumValues:created_by

Resource type identifier.

relationstringenumValues:internalcustomersystem

The creator's relationship to the account that owns the resource.

  • internal: created by a user of the owning account.
  • customer: created by a customer of the owning account.
  • system: created automatically with no human actor (e.g. an EDI import).
actoractornullable

The actor who created the resource.

Absent when relation is system, since no human or programmatic actor performed the action.

Always returned as null in this endpoint.
freightfreightExpandablenullable

Carrier selection and freight billing carried from the sales order this pick fulfills.

objectstringenumValues:freight

Resource type identifier.

policystringnullableenumValues:free_freightbilled_freight

How freight is arranged and billed for the record.

  • free_freight: no shipping cost to the buyer.
  • billed_freight: freight is billed to the buyer.

Sales orders, purchase orders, and shipments do not carry a policy of their own. Freight on those records is waived when the customer's freight preferences, the customer's type group, any of its pricing groups, the customer's shipping term, or any product line on the order is free_freight.

carriercarriernullable

The shipping carrier selected to fulfill the shipment.

Always returned as null in this endpoint.
service_levelservice_levelnullable

The carrier service level selected for the shipment (e.g. ground, overnight).

Always returned as null in this endpoint.
billing_typestringnullableenumValues:senderthird_party

Which party the carrier bills for the shipment.

  • sender: the shipper (your account) is billed.
  • third_party: a third party is billed via billing_account_number.
billing_account_numberstringnullable

Carrier account number to bill, used when billing_type is third_party.

prioritystringenumValues:lownormalhigh

How urgently the pick should be worked.

ship_toaddressnullable

Address the associated sales order ships to.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

  • standard: a normal shipping or billing address.
  • drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.
receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

The most specific link in the receiving chain: set it when one of a customer's sites keeps different days from the rest. Null falls through to the customer, then their group, then the account default.

geolocationgeolocationnullable

Street-level location details for the address.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

line_countinteger

Number of lines on this pick.

totalspick_totalsnullable

Progress through picking and packing, aggregated over the pick's sale lines so a list row can render progress bars without expanding lines.

objectstringenumValues:pick_totals

Resource type identifier.

pickedpick_stage_total

How far picking has progressed.

objectstringenumValues:pick_stage_total

Resource type identifier.

completionnumber

Progress as a fraction between 0 and 1.

packedpick_stage_total

How far packing has progressed.

objectstringenumValues:pick_stage_total

Resource type identifier.

completionnumber

Progress as a fraction between 0 and 1.

last_shipped_atstring (date-time)nullable

Timestamp of the most recent shipment sent (null until shipped).

lineslistExpandablenullable

The pick's lines, each tracking the quantity picked against one sales order line.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of pick_line

Resources in this page.

idstring

Pick line ID.

objectstringenumValues:pick_line

Resource type identifier.

itemitemnullable

The item this line picks, named by the originating sales order line and returned as it stands now rather than as it was when the order was placed.

Always returned as null in this endpoint.
quantityquantitynullable

Quantity actually picked for this line. A value of 0 means nothing has been picked yet.

Always returned as null in this endpoint.
ordered_quantityquantitynullable

Quantity requested by the originating sales order line for this pick line.

Always returned as null in this endpoint.
sales_order_linesales_order_linenullable

The sales order line this pick line fulfills.

Always returned as null in this endpoint.
packed_atstring (date-time)nullable

Timestamp when the line was packed.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

relatedpick_relatednullable

Records this pick sits between — the order it fulfills and the shipments packed from it.

objectstringenumValues:pick_related

Resource type identifier.

sales_orderrecordExpandablenullable

The sales order this pick fulfills.

idstring

Unique identifier for the record.

objectstringenumValues:record

Resource type identifier.

typestringenumValues:sales_orderpurchase_orderreceiving_order

The kind of business record referenced.

Determines how to resolve the record and which status and metadata keys may appear.

  • sales_order: a customer order.
  • purchase_order: an order placed with a supplier.
  • receiving_order: an inbound order being received into inventory.
  • pick: a warehouse pick task.
  • shipment: an outbound shipment.
  • delivery: a delivery of one or more shipments to a destination.
  • production_run: a manufacturing production run.
  • invoice: a customer invoice.
  • transaction: a payment or financial transaction.
  • settlement: a settlement reconciling transactions against invoices.
numberstringnullable

Human-readable record number, when the record has one.

statusstringnullable

Type-specific status code, when applicable.

metadataobject

Type-specific metadata.

The set of keys varies by record type.

shipmentslistExpandablenullable

Lists the shipments packed from this pick.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of record

Resources in this page.

idstring

Unique identifier for the record.

objectstringenumValues:record

Resource type identifier.

typestringenumValues:sales_orderpurchase_orderreceiving_order

The kind of business record referenced.

Determines how to resolve the record and which status and metadata keys may appear.

  • sales_order: a customer order.
  • purchase_order: an order placed with a supplier.
  • receiving_order: an inbound order being received into inventory.
  • pick: a warehouse pick task.
  • shipment: an outbound shipment.
  • delivery: a delivery of one or more shipments to a destination.
  • production_run: a manufacturing production run.
  • invoice: a customer invoice.
  • transaction: a payment or financial transaction.
  • settlement: a settlement reconciling transactions against invoices.
numberstringnullable

Human-readable record number, when the record has one.

statusstringnullable

Type-specific status code, when applicable.

metadataobject

Type-specific metadata.

The set of keys varies by record type.

finished_atstring (date-time)nullable

Timestamp when the pick was finished.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

commitmentcommitmentnullable

When the order this pick fulfills is due to ship, carried from the order so the pick can explain its own deadline without expanding it.

The calendar adjustment and the overrides that produced the date stay on the order; a pick carries the date, not the authoring history behind it.

objectstringenumValues:commitment

Resource type identifier.

promised_atstring (date-time)nullable

Date delivery was promised to the customer, if one was committed.

lead_time_override_daysintegernullable

Days between issue and the ship-by date, set on this record alone in place of the customer's standing lead time.

ship_by_override_datestring (date-time)nullable

The ship date pinned by hand, bypassing transit and the customer's receiving days.

ship_by_datestring (date-time)nullable

When the record is contractually due to ship.

Stamped at issue. With a promised delivery date, this is that date less the carrier's transit for the order's lane and less any day the customer cannot receive on — when the order has to leave to arrive when promised. Otherwise it comes from a lead time, whether the order's own or the one on the customer, its parent account, its account group, or the account.

Always a day the plant actually ships on, whichever rule produced it, and carries the plant's pickup cutoff as its time of day when the shipping calendar sets one — the moment freight has to be tendered by, not just the day. Midnight UTC means no cutoff is configured rather than a deadline at midnight.

Recomputed while the order is still open whenever something it was derived from moves — the basis above, or the carrier, service level, or ship-to address the transit was quoted on. Renegotiating a customer's standing lead time or adding a holiday to a calendar does not reach back into commitments already made. Cleared if the order is unissued.

lead_time_daysintegernullable

Calendar days between issue and the ship-by date.

lead_time_sourcestringnullableenumValues:customerparent_customeraccount_group

Which rule produced the ship-by date.

transit_daysintegernullable

Business days the carrier needs to cover this lane, subtracted from the promised delivery date to reach the ship-by date.

Only set when a delivery date was promised and the lane could be priced. Without it the ship-by date falls back to the promised date itself.

transit_sourcestringnullableenumValues:carrier_laneservice_level

Where the transit estimate came from.

calendar_adjustment_daysintegernullable

Days the customer's receiving calendar and the plant's shipping calendar pulled the ship-by date back, beyond what carrier transit accounted for.

Zero means every date along the way already fell on an open day. This is what explains a ship-by date that is earlier than transit alone would suggest.

estimated_delivery_datestring (date-time)nullable

When freight leaving on the ship-by date would reach the customer: transit walked forward from it and landed on a day their dock receives.

Reported by the commitment preview, which is asked what a set of inputs would produce and so computes the arrival too. A record carries the commitment it was stamped with, not a projection, and leaves this null.

Responses

200

Successful response for Retrieve Pick