Get Fulfillment by Source ID

get https://us2-api.bringg.com/v2/orders/{order_id}/fulfillments/source_id/{source_id}

Get the details of a fulfillment using its Source ID.

Responses

Response body

object

double

required

The ID of this object in Delivery Hub.

source_id

string

Your source system's ID for this fulfillment.

order_id

double

Bringg's ID for this order.

sender_id

double

required

sender

object

double

required

The ID of this object in Delivery Hub.

language

string

The customer's locale (ISO6391), which defines the Delivery Notification language for this order. Learn more about configuring notifications.

allow_sms

boolean

required

If allow_sms is true, send notifications to customer by SMS.

allow_email

boolean

required

If allow_email is true, send notifications to customer by email.

created_at

string

required

The date and time when this object was created in Delivery Hub.

updated_at

string

required

The date and time when this object was updated in Delivery Hub.

delete_at

string

The date and time when this object was deleted from Delivery Hub.

name

string

required

The customer's first and last name.

string

The customer's email address.

phone

string

required

The customer's phone number.

recipient_id

double

required

recipient

object

double

required

The ID of this object in Delivery Hub.

language

string

The customer's locale (ISO6391), which defines the Delivery Notification language for this order. Learn more about configuring notifications.

allow_sms

boolean

required

If allow_sms is true, send notifications to customer by SMS.

allow_email

boolean

required

If allow_email is true, send notifications to customer by email.

created_at

string

required

The date and time when this object was created in Delivery Hub.

updated_at

string

required

The date and time when this object was updated in Delivery Hub.

delete_at

string

The date and time when this object was deleted from Delivery Hub.

name

string

required

The customer's first and last name.

string

The customer's email address.

phone

string

required

The customer's phone number.

user_id

double

When relevant, the ID of the user who implemented a change. For example, this could be the ID of the user who created a shipment.

delete_at

string

The date and time when this object was deleted from Delivery Hub.

created_at

string

required

The date and time when this object was created in Delivery Hub.

updated_at

string

required

The date and time when this object was updated in Delivery Hub.

shipping_account_id

double

The shipping account used for the quoted or actual booking.
Required when service is present. This is used when the end-customer selects the carrier and service for a shipment.

service

string

The service level for the quoted booking, such as same-day.

sender_address_id

double

required

sender_address

object

double

required

The ID of this object in Delivery Hub.

user_id

double

When relevant, the ID of the user who implemented a change. For example, this could be the ID of the user who created a shipment.

created_at

string

required

The date and time when this object was created in Delivery Hub.

updated_at

string

required

The date and time when this object was updated in Delivery Hub.

delete_at

string

The date and time when this object was deleted from Delivery Hub.

street1

string

required

The first line of the street address, including the street name or PO Box number.

postal_code

string

required

Postal or ZIP code.

city

string

required

City, district, suburb, town, or village.

country

string

required

Two letter ISO country code. Learn more: https://www.iso.org/obp/ui/#search

AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

street2

string

(Optional) The second line of the street address, including the apartment number.

street3

string

state

string

(Optional, based on country) State, province, or region.

address_type

string

The type of location. Example: business, residential.

commercial residential educational government medical industrial shipping_location

company

string

The company name, when shipping to a business address.

recipient_address_id

double

required

The ID for this address in Delivery Hub.

recipient_address

object

double

required

The ID of this object in Delivery Hub.

user_id

double

When relevant, the ID of the user who implemented a change. For example, this could be the ID of the user who created a shipment.

created_at

string

required

The date and time when this object was created in Delivery Hub.

updated_at

string

required

The date and time when this object was updated in Delivery Hub.

delete_at

string

The date and time when this object was deleted from Delivery Hub.

street1

string

required

The first line of the street address, including the street name or PO Box number.

postal_code

string

required

Postal or ZIP code.

city

string

required

City, district, suburb, town, or village.

country

string

required

Two letter ISO country code. Learn more: https://www.iso.org/obp/ui/#search

street2

string

(Optional) The second line of the street address, including the apartment number.

street3

string

state

string

(Optional, based on country) State, province, or region.

address_type

string

The type of location. Example: business, residential.

commercial residential educational government medical industrial shipping_location

company

string

The company name, when shipping to a business address.

sender_location_id

double

Delivery Hub's or your source system's ID for the sender's location. This is the shipping location for delivery use cases.

recipient_location_id

double

Delivery Hub's or your source system's ID for the recipient's location. Forbidden if recipient or recipient_address are present.

sender_location

object

double

required

The ID of this object in Delivery Hub.

name

string

required

description

string

required

type

string

required

Warehouse Store Distribution center

user_id

double

required

When relevant, the ID of the user who implemented a change. For example, this could be the ID of the user who created a shipment.

created_at

string

required

The date and time when this object was created in Delivery Hub.

updated_at

string

required

The date and time when this object was updated in Delivery Hub.

delete_at

string

The date and time when this object was deleted from Delivery Hub.

address

object

address_id

double

source_id

string

recipient_location

object

double

required

The ID of this object in Delivery Hub.

name

string

required

description

string

required

type

string

required

Warehouse Store Distribution center

user_id

double

required

When relevant, the ID of the user who implemented a change. For example, this could be the ID of the user who created a shipment.

created_at

string

required

The date and time when this object was created in Delivery Hub.

updated_at

string

required

The date and time when this object was updated in Delivery Hub.

delete_at

string

The date and time when this object was deleted from Delivery Hub.

address

object

address_id

double

source_id

string

quote_id

string

ID for the quote offered or selected at checkout.

status

string

required

Quoted New PartiallyFulfilled ReadyToShip PickedUp InTransit OutForDelivery Delivered Exception CanceledByCarrier Canceled

fulfillment_type

string

required

Designates if this is a delivery or return.

delivery return

fulfillment_method

string

required

Designates if the fulfillment method is direct delivery to the recipient's address or via a PUDO (pickup/dropoff) location.

pudo direct

pudo_location_id

string

The ID of the PUDO (pickup/drop off) location of the sender or recipient.

deliver_by

string

items_count

double

The total number of items included in this object.

total_weight

double

name

string

fulfillments_products

array of objects

fulfillments_products

object

fulfillment_id

double

required

Bringg's ID for this fulfillment.

product_id

double

required

product

object

count

double

required

The amount or number of a specific product purchased.

double

required

The ID of this object in Delivery Hub.

created_at

string

required

The date and time when this object was created in Delivery Hub.

updated_at

string

required

The date and time when this object was updated in Delivery Hub.

delete_at

string

The date and time when this object was deleted from Delivery Hub.

last_updated_by

double

The user identifier who did the last update on the fulfillment.

shipment_account_ids

array of doubles

shipment_account_ids

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us2-api.bringg.com/v2/orders/order_id/fulfillments/source_id/source_id \
3
     --header 'accept: application/json'


xxxxxxxxxx
56
}
1
{
2
  "id": 1414,
3
  "order_id": 1212,
4
  "shipping_account_id": 27272,
5
  "service": "Night Delivery",
6
  "items_count": 22,
7
  "total_weight": 33,
8
  "name": "BackPack",
9
  "status": "New",
10
  "fulfillment_type": "delivery",
11
  "fulfillment_method": "direct",
12
  "recipient_id": 1515,
13
  "recipient": {
14
    "name": "Jack Martin",
15
    "email": "jack.martin@bringg.com",
16
    "phone": "+12125550197",
17
    "id": 1515,
18
    "allow_email": false,
19
    "allow_sms": true
20
  },
21
  "sender_id": 1818,
22
  "sender": {
23
    "name": "John Doe",
24
    "email": "john.doe@bringg.com",
25
    "phone": "+12125550222",

200Success

400Bad Request

403Forbidden