Order
Last updated
Last updated
POST https://api.gomalomo.com/orders
{
"alternate_id": "450789469",
"created_at": "2019-01-30T13:30:00Z",
"customer": {
"email": "john@example.com",
"first_name": "John",
"last_name": "Smith"
},
"email": "john@example.com",
"id": "58f3d13f-2979-462b-92f8-4b85c6ee6abe",
"meta": {
"shopify_order": {
"order_id": 450789469
}
}
"number": "1000",
"shipments": [
{
"alternative_carrier_identifier": null,
"carrier": "usps",
"carrier_name": "USPS",
"carrier_service": "First-Class Package Service",
"carrier_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9400000000000000000000"
"container_type": null,
"delivered_at": "2019-01-30T13:30:00",
"destination": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"estimated_delivered_at": "2019-01-30T13:30:00",
"estimated_local_delivered_at": null,
"estimated_local_delivered_on": null,
"guaranteed_delivered_at": null,
"id": "ef1e8884-5188-457a-950a-6247c5e59e91",
"initial_delivery_attempted_at": "2019-01-30T13:30:00",
"is_return": false,
"origin": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"original_estimated_delivered_at": "2019-01-30T13:30:00",
"scan_events": [
{
"carrier_code": "GX",
"description": "Shipping Label Created, USPS Awaiting Item",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN",
},
"message": "January 28 1:23 pm Shipping Label Created, USPS Awaiting Item in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T13:23:00",
"source": "USPS",
"status": "pre_transit",
"status_detail": "label_created"
},
{
"carrier_code": "OA",
"description": "Accepted at USPS Origin Facility",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 28 8:29 pm Accepted at USPS Origin Facility in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T20:29:00",
"source": "USPS",
"status": "in_transit",
"status_detail": "received_at_origin_facility"
},
{
"carrier_code": "OF",
"description": "Out for Delivery",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 9:16 am Out for Delivery in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T09:16:00",
"source": "USPS",
"status": "out_for_delivery",
"status_detail": "out_for_delivery"
},
{
"carrier_code": "01",
"description": "Delivered, In/At Mailbox",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 1:30 pm Delivered, In/At Mailbox in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T13:30:00",
"source": "USPS",
"status": "delivered",
"status_detail": "arrived_at_destination"
}
],
"signed_by": "null",
"status": "delivered",
"tracking_code": "9400000000000000000000",
"weight": null
}
],
"updated_at": "2019-01-30T13:30:00Z"
}GET https://api.gomalomo.com/orders/:id
{
"alternate_id": "450789469",
"created_at": "2019-01-30T13:30:00Z",
"customer": {
"email": "john@example.com",
"first_name": "John",
"last_name": "Smith"
},
"email": "john@example.com",
"id": "58f3d13f-2979-462b-92f8-4b85c6ee6abe",
"meta": {
"shopify_order": {
"order_id": 450789469
}
}
"number": "1000",
"shipments": [
{
"alternative_carrier_identifier": null,
"carrier": "usps",
"carrier_name": "USPS",
"carrier_service": "First-Class Package Service",
"carrier_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9400000000000000000000"
"container_type": null,
"delivered_at": "2019-01-30T13:30:00",
"destination": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"estimated_delivered_at": "2019-01-30T13:30:00",
"estimated_local_delivered_at": null,
"estimated_local_delivered_on": null,
"guaranteed_delivered_at": null,
"id": "ef1e8884-5188-457a-950a-6247c5e59e91",
"initial_delivery_attempted_at": "2019-01-30T13:30:00",
"is_return": false,
"origin": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"original_estimated_delivered_at": "2019-01-30T13:30:00",
"scan_events": [
{
"carrier_code": "GX",
"description": "Shipping Label Created, USPS Awaiting Item",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN",
},
"message": "January 28 1:23 pm Shipping Label Created, USPS Awaiting Item in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T13:23:00",
"source": "USPS",
"status": "pre_transit",
"status_detail": "label_created"
},
{
"carrier_code": "OA",
"description": "Accepted at USPS Origin Facility",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 28 8:29 pm Accepted at USPS Origin Facility in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T20:29:00",
"source": "USPS",
"status": "in_transit",
"status_detail": "received_at_origin_facility"
},
{
"carrier_code": "OF",
"description": "Out for Delivery",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 9:16 am Out for Delivery in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T09:16:00",
"source": "USPS",
"status": "out_for_delivery",
"status_detail": "out_for_delivery"
},
{
"carrier_code": "01",
"description": "Delivered, In/At Mailbox",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 1:30 pm Delivered, In/At Mailbox in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T13:30:00",
"source": "USPS",
"status": "delivered",
"status_detail": "arrived_at_destination"
}
],
"signed_by": "null",
"status": "delivered",
"tracking_code": "9400000000000000000000",
"weight": null
}
],
"updated_at": "2019-01-30T13:30:00Z"
}GET https://api.gomalomo.com/orders/?alternate_id=:alternate_id
{
"alternate_id": "450789469",
"created_at": "2019-01-30T13:30:00Z",
"customer": {
"email": "john@example.com",
"first_name": "John",
"last_name": "Smith"
},
"email": "john@example.com",
"id": "58f3d13f-2979-462b-92f8-4b85c6ee6abe",
"meta": {
"shopify_order": {
"order_id": 450789469
}
}
"number": "1000",
"shipments": [
{
"alternative_carrier_identifier": null,
"carrier": "usps",
"carrier_name": "USPS",
"carrier_service": "First-Class Package Service",
"carrier_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9400000000000000000000"
"container_type": null,
"delivered_at": "2019-01-30T13:30:00",
"destination": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"estimated_delivered_at": "2019-01-30T13:30:00",
"estimated_local_delivered_at": null,
"estimated_local_delivered_on": null,
"guaranteed_delivered_at": null,
"id": "ef1e8884-5188-457a-950a-6247c5e59e91",
"initial_delivery_attempted_at": "2019-01-30T13:30:00",
"is_return": false,
"origin": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"original_estimated_delivered_at": "2019-01-30T13:30:00",
"scan_events": [
{
"carrier_code": "GX",
"description": "Shipping Label Created, USPS Awaiting Item",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN",
},
"message": "January 28 1:23 pm Shipping Label Created, USPS Awaiting Item in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T13:23:00",
"source": "USPS",
"status": "pre_transit",
"status_detail": "label_created"
},
{
"carrier_code": "OA",
"description": "Accepted at USPS Origin Facility",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 28 8:29 pm Accepted at USPS Origin Facility in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T20:29:00",
"source": "USPS",
"status": "in_transit",
"status_detail": "received_at_origin_facility"
},
{
"carrier_code": "OF",
"description": "Out for Delivery",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 9:16 am Out for Delivery in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T09:16:00",
"source": "USPS",
"status": "out_for_delivery",
"status_detail": "out_for_delivery"
},
{
"carrier_code": "01",
"description": "Delivered, In/At Mailbox",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 1:30 pm Delivered, In/At Mailbox in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T13:30:00",
"source": "USPS",
"status": "delivered",
"status_detail": "arrived_at_destination"
}
],
"signed_by": "null",
"status": "delivered",
"tracking_code": "9400000000000000000000",
"weight": null
}
],
"updated_at": "2019-01-30T13:30:00Z"
}GET https://api.gomalomo.com/orders/?tracking_code=:tracking_code
{
"alternate_id": "450789469",
"created_at": "2019-01-30T13:30:00Z",
"customer": {
"email": "john@example.com",
"first_name": "John",
"last_name": "Smith"
},
"email": "john@example.com",
"id": "58f3d13f-2979-462b-92f8-4b85c6ee6abe",
"meta": {
"shopify_order": {
"order_id": 450789469
}
}
"number": "1000",
"shipments": [
{
"alternative_carrier_identifier": null,
"carrier": "usps",
"carrier_name": "USPS",
"carrier_service": "First-Class Package Service",
"carrier_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9400000000000000000000"
"container_type": null,
"delivered_at": "2019-01-30T13:30:00",
"destination": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"estimated_delivered_at": "2019-01-30T13:30:00",
"estimated_local_delivered_at": null,
"estimated_local_delivered_on": null,
"guaranteed_delivered_at": null,
"id": "ef1e8884-5188-457a-950a-6247c5e59e91",
"initial_delivery_attempted_at": "2019-01-30T13:30:00",
"is_return": false,
"origin": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"original_estimated_delivered_at": "2019-01-30T13:30:00",
"scan_events": [
{
"carrier_code": "GX",
"description": "Shipping Label Created, USPS Awaiting Item",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN",
},
"message": "January 28 1:23 pm Shipping Label Created, USPS Awaiting Item in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T13:23:00",
"source": "USPS",
"status": "pre_transit",
"status_detail": "label_created"
},
{
"carrier_code": "OA",
"description": "Accepted at USPS Origin Facility",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 28 8:29 pm Accepted at USPS Origin Facility in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T20:29:00",
"source": "USPS",
"status": "in_transit",
"status_detail": "received_at_origin_facility"
},
{
"carrier_code": "OF",
"description": "Out for Delivery",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 9:16 am Out for Delivery in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T09:16:00",
"source": "USPS",
"status": "out_for_delivery",
"status_detail": "out_for_delivery"
},
{
"carrier_code": "01",
"description": "Delivered, In/At Mailbox",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 1:30 pm Delivered, In/At Mailbox in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T13:30:00",
"source": "USPS",
"status": "delivered",
"status_detail": "arrived_at_destination"
}
],
"signed_by": "null",
"status": "delivered",
"tracking_code": "9400000000000000000000",
"weight": null
}
],
"updated_at": "2019-01-30T13:30:00Z"
}GET https://api.gomalomo.com/orders/?number=:number&customer_email=:customer_email
{
"alternate_id": "450789469",
"created_at": "2019-01-30T13:30:00Z",
"customer": {
"email": "john@example.com",
"first_name": "John",
"last_name": "Smith"
},
"email": "john@example.com",
"id": "58f3d13f-2979-462b-92f8-4b85c6ee6abe",
"meta": {
"shopify_order": {
"order_id": 450789469
}
}
"number": "1000",
"shipments": [
{
"alternative_carrier_identifier": null,
"carrier": "usps",
"carrier_name": "USPS",
"carrier_service": "First-Class Package Service",
"carrier_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9400000000000000000000"
"container_type": null,
"delivered_at": "2019-01-30T13:30:00",
"destination": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"estimated_delivered_at": "2019-01-30T13:30:00",
"estimated_local_delivered_at": null,
"estimated_local_delivered_on": null,
"guaranteed_delivered_at": null,
"id": "ef1e8884-5188-457a-950a-6247c5e59e91",
"initial_delivery_attempted_at": "2019-01-30T13:30:00",
"is_return": false,
"origin": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"original_estimated_delivered_at": "2019-01-30T13:30:00",
"scan_events": [
{
"carrier_code": "GX",
"description": "Shipping Label Created, USPS Awaiting Item",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN",
},
"message": "January 28 1:23 pm Shipping Label Created, USPS Awaiting Item in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T13:23:00",
"source": "USPS",
"status": "pre_transit",
"status_detail": "label_created"
},
{
"carrier_code": "OA",
"description": "Accepted at USPS Origin Facility",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 28 8:29 pm Accepted at USPS Origin Facility in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T20:29:00",
"source": "USPS",
"status": "in_transit",
"status_detail": "received_at_origin_facility"
},
{
"carrier_code": "OF",
"description": "Out for Delivery",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 9:16 am Out for Delivery in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T09:16:00",
"source": "USPS",
"status": "out_for_delivery",
"status_detail": "out_for_delivery"
},
{
"carrier_code": "01",
"description": "Delivered, In/At Mailbox",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 1:30 pm Delivered, In/At Mailbox in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T13:30:00",
"source": "USPS",
"status": "delivered",
"status_detail": "arrived_at_destination"
}
],
"signed_by": "null",
"status": "delivered",
"tracking_code": "9400000000000000000000",
"weight": null
}
],
"updated_at": "2019-01-30T13:30:00Z"
}GET https://api.gomalomo.com/orders
[
{
"alternate_id": "450789469",
"created_at": "2019-01-30T13:30:00Z",
"customer": {
"email": "john@example.com",
"first_name": "John",
"last_name": "Smith"
},
"email": "john@example.com",
"id": "58f3d13f-2979-462b-92f8-4b85c6ee6abe",
"meta": {
"shopify_order": {
"order_id": 450789469
}
}
"number": "1000",
"shipments": [
{
"alternative_carrier_identifier": null,
"carrier": "usps",
"carrier_name": "USPS",
"carrier_service": "First-Class Package Service",
"carrier_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9400000000000000000000"
"container_type": null,
"delivered_at": "2019-01-30T13:30:00",
"destination": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"estimated_delivered_at": "2019-01-30T13:30:00",
"estimated_local_delivered_at": null,
"estimated_local_delivered_on": null,
"guaranteed_delivered_at": null,
"id": "ef1e8884-5188-457a-950a-6247c5e59e91",
"initial_delivery_attempted_at": "2019-01-30T13:30:00",
"is_return": false,
"origin": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"original_estimated_delivered_at": "2019-01-30T13:30:00",
"scan_events": [
{
"carrier_code": "GX",
"description": "Shipping Label Created, USPS Awaiting Item",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN",
},
"message": "January 28 1:23 pm Shipping Label Created, USPS Awaiting Item in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T13:23:00",
"source": "USPS",
"status": "pre_transit",
"status_detail": "label_created"
},
{
"carrier_code": "OA",
"description": "Accepted at USPS Origin Facility",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 28 8:29 pm Accepted at USPS Origin Facility in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T20:29:00",
"source": "USPS",
"status": "in_transit",
"status_detail": "received_at_origin_facility"
},
{
"carrier_code": "OF",
"description": "Out for Delivery",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 9:16 am Out for Delivery in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T09:16:00",
"source": "USPS",
"status": "out_for_delivery",
"status_detail": "out_for_delivery"
},
{
"carrier_code": "01",
"description": "Delivered, In/At Mailbox",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 1:30 pm Delivered, In/At Mailbox in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T13:30:00",
"source": "USPS",
"status": "delivered",
"status_detail": "arrived_at_destination"
}
],
"signed_by": "null",
"status": "delivered",
"tracking_code": "9400000000000000000000",
"weight": null
}
],
"updated_at": "2019-01-30T13:30:00Z"
}
]PUT https://api.gomalomo.com/orders/:id
{
"alternate_id": "450789469",
"created_at": "2019-01-30T13:30:00Z",
"customer": {
"email": "john@example.com",
"first_name": "John",
"last_name": "Smith"
},
"email": "john@example.com",
"id": "58f3d13f-2979-462b-92f8-4b85c6ee6abe",
"meta": {
"shopify_order": {
"order_id": 450789469
}
}
"number": "1000",
"shipments": [
{
"alternative_carrier_identifier": null,
"carrier": "usps",
"carrier_name": "USPS",
"carrier_service": "First-Class Package Service",
"carrier_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9400000000000000000000"
"container_type": null,
"delivered_at": "2019-01-30T13:30:00",
"destination": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"estimated_delivered_at": "2019-01-30T13:30:00",
"estimated_local_delivered_at": null,
"estimated_local_delivered_on": null,
"guaranteed_delivered_at": null,
"id": "ef1e8884-5188-457a-950a-6247c5e59e91",
"initial_delivery_attempted_at": "2019-01-30T13:30:00",
"is_return": false,
"origin": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"original_estimated_delivered_at": "2019-01-30T13:30:00",
"scan_events": [
{
"carrier_code": "GX",
"description": "Shipping Label Created, USPS Awaiting Item",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN",
},
"message": "January 28 1:23 pm Shipping Label Created, USPS Awaiting Item in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T13:23:00",
"source": "USPS",
"status": "pre_transit",
"status_detail": "label_created"
},
{
"carrier_code": "OA",
"description": "Accepted at USPS Origin Facility",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 28 8:29 pm Accepted at USPS Origin Facility in INDIANAPOLIS, IN",
"scanned_at": "2019-01-28T20:29:00",
"source": "USPS",
"status": "in_transit",
"status_detail": "received_at_origin_facility"
},
{
"carrier_code": "OF",
"description": "Out for Delivery",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 9:16 am Out for Delivery in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T09:16:00",
"source": "USPS",
"status": "out_for_delivery",
"status_detail": "out_for_delivery"
},
{
"carrier_code": "01",
"description": "Delivered, In/At Mailbox",
"location": {
"city": "INDIANAPOLIS",
"country": null,
"postal_code": "46203",
"state": "IN"
},
"message": "January 30 1:30 pm Delivered, In/At Mailbox in INDIANAPOLIS, IN",
"scanned_at": "2019-01-30T13:30:00",
"source": "USPS",
"status": "delivered",
"status_detail": "arrived_at_destination"
}
],
"signed_by": "null",
"status": "delivered",
"tracking_code": "9400000000000000000000",
"weight": null
}
],
"updated_at": "2019-01-30T13:30:00Z"
}DELETE https://api.gomalomo.com/orders/:id
POST https://api.gomalomo.com/orders/:order_id/events
{
"created_at": "2019-01-30T13:30:00Z",
"id": "1a3c1090-efd1-11eb-9a03-0242ac130003",
"label": "Order #1000 fulfilled",
"link_back_url": "https://goodest-boi.myshopify.com/admin/orders/5555555555555",