Atlas CRUD API Endpoints old2
by AngeliaGong-narvar

Atlas CRUD API Endpoints old2

Operations
atlas-customer-controller

Atlas Customer Controller

getCustomer
GET /atlas/api/v1/customer/{customer_id}
getCustomer
GET /atlas/api/v1/customer/{customer_id}

Path variables

customer_id
string required

customer_id

Request parameters

message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
ATLAS_DATA

Request body

application/json

Responses

200 200

OK

Body
application/json
Customer
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
atlas-item-controller

Atlas Item Controller

getItemsWithoutOrderNumber
GET /atlas/api/v1/{retailer_moniker}/items
getItems
GET /atlas/api/v1/{retailer_moniker}/{order_number}/items
getItemsWithoutOrderNumber
GET /atlas/api/v1/{retailer_moniker}/items

Path variables

retailer_moniker
string required

retailer_moniker

Request parameters

item_id
string optional

item_id

sku
string optional

sku

message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
ATLAS_DATA

Request body

application/json

Responses

200 200

OK

Body
application/json
Array of Item
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
getItems
GET /atlas/api/v1/{retailer_moniker}/{order_number}/items

Path variables

retailer_moniker
string required

retailer_moniker

order_number
string required

order_number

Request parameters

item_id
string optional

item_id

sku
string optional

sku

message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
ATLAS_DATA

Request body

application/json

Responses

200 200

OK

Body
application/json
Array of Item
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
atlas-order-controller

Atlas Order Controller

getOrder
GET /atlas/api/v1/{retailer_moniker}/{order_number}
getOrder
GET /atlas/api/v1/{retailer_moniker}/{order_number}

Path variables

retailer_moniker
string required

retailer_moniker

order_number
string required

order_number

Request parameters

message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
ATLAS_DATA

Request body

application/json

Responses

200 200

OK

Body
application/json
AtlasResponse
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
atlas-pickup-controller

Atlas Pickup Controller

getPickups
GET /atlas/api/v1/{retailer_moniker}/{order_number}/pickups
getPickups
GET /atlas/api/v1/{retailer_moniker}/{order_number}/pickups

Path variables

retailer_moniker
string required

retailer_moniker

order_number
string required

order_number

Request parameters

pickup_id
string optional

pickup_id

message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
ATLAS_DATA

Request body

application/json

Responses

200 200

OK

Body
application/json
Array of Pickup
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
atlas-shipment-controller

Atlas Shipment Controller

getShipments
GET /atlas/api/v1/{retailer_moniker}/{order_number}/shipments
getShipments
GET /atlas/api/v1/{retailer_moniker}/{order_number}/shipments

Path variables

retailer_moniker
string required

retailer_moniker

order_number
string required

order_number

Request parameters

tracking_number
string optional

tracking_number

message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
ATLAS_DATA

Request body

application/json

Responses

200 200

OK

Body
application/json
Array of ShipmentInfo
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
atlas-order-tracking-controller

Atlas Order Tracking Controller

getOrder
GET /atlas/order
schedulerOrderUpdate
POST /atlas/scheduler/order
schedulerOrderUpdateFulfillmentDelay
POST /atlas/scheduler/order/dbstate
schedulerTrackingUpdate
POST /atlas/scheduler/tracking
getTracking
GET /atlas/tracking
getOrder
GET /atlas/order

Request parameters

order_number
string required

order_number

retailer_moniker
string required

retailer_moniker

datasource_override
string optional

datasource_override

Enumeration:
DB
CARRIER_CALL
NONE
Default:
NONE
message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
TRACK_ATLAS

Request body

application/json

Responses

200 200

OK

Body
application/json
AtlasResponse
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
schedulerOrderUpdate
POST /atlas/scheduler/order

Request parameters

order_number
string required

order_number

retailer_moniker
string required

retailer_moniker

freshness_minutes
integer int32 optional

freshness_minutes

datasource_override
string optional

datasource_override

Enumeration:
DB
CARRIER_CALL
NONE
Default:
NONE
message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
SCHEDULAR_ORDER_ATLAS

Request body

application/json

Responses

200 200

OK

Body
application/json
Object
201 201

Created

application/json
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
schedulerOrderUpdateFulfillmentDelay
POST /atlas/scheduler/order/dbstate

Request parameters

order_number
string required

order_number

retailer_moniker
string required

retailer_moniker

freshness_minutes
integer int32 optional

freshness_minutes

datasource_override
string optional

datasource_override

Enumeration:
DB
CARRIER_CALL
NONE
Default:
NONE
message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
SCHEDULAR_ORDER_ATLAS

Request body

application/json

Responses

200 200

OK

Body
application/json
Object
201 201

Created

application/json
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
schedulerTrackingUpdate
POST /atlas/scheduler/tracking

Request parameters

tracking_number
string optional

tracking_number

carrier_moniker
string required

carrier_moniker

retailer_moniker
string required

retailer_moniker

order_number
string optional

order_number

datasource_override
string optional

datasource_override

Enumeration:
DB
CARRIER_CALL
NONE
Default:
NONE
multi_ship
boolean optional

multi_ship

carrierParameters
string optional

carrierParameters

freshness_minutes
integer int32 optional

freshness_minutes

message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
SCHEDULAR_TRACK_ATLAS

Request body

application/json

Responses

200 200

OK

Body
application/json
Object
201 201

Created

application/json
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
getTracking
GET /atlas/tracking

Request parameters

tracking_number
string optional

tracking_number

carrier_moniker
string required

carrier_moniker

retailer_moniker
string required

retailer_moniker

order_number
string optional

order_number

datasource_override
string optional

datasource_override

Enumeration:
DB
CARRIER_CALL
NONE
Default:
NONE
multi_ship
boolean optional

multi_ship

carrierParameters
string optional

carrierParameters

message_origin
string optional

message_origin

Enumeration:
TRACKING
NOTIFY_SCHEDULER
NOTIFY_CNP
NOTIFY_RULES_ENGINE_LAMBDA
NOTIFY_RULES_ENGINE_PULSAR
TRACK_ATLAS
SCHEDULAR_TRACK_ATLAS
SCHEDULAR_ORDER_ATLAS
ATLAS
ATLAS_DATA
Default:
TRACK_ATLAS

Request body

application/json

Responses

200 200

OK

Body
application/json
AtlasResponse
401 401

Unauthorized

application/json
403 403

Forbidden

application/json
404 404

Not Found

application/json
Type Definitions
ReturnItem
Object
exchange_item
ExchangeItem
item_category
string
narvar_return_type
string
parent_sku
string
product_sku
string
repair_reason_fee
number float
retailer_reason_code
string
return_quantity
integer int32
return_reason
string
return_reason_locale
string
user_comment
string
Tracking
Object
audit_log
Array of Audit
carrier_moniker
string
carrier_status_code
string
carrier_transfer
boolean
created_date
string
current_event_code
string
current_event_date
string
current_event_date_raw
string
current_event_date_with_derived_offset
string
db_id
string
delivered_not_received_initiated
boolean
delivery
Delivery
delivery_carrier
string
delivery_notification_date
string
dest
Address
edd_derived
EddDerived
edd_source
string
events
Array of Event
modified_date
string
non_delivery_responses
Array of NonDeliveryResponse
origin
Address
package_count
string
package_redirect
string
partner_tracking_number
string
phone_number
string
previous_event_code
Array of string
record_updaters
Array of string
redirect_address
Address
redirect_to_hold
RedirectToHold
reference_number
string
rescheduled_delivery_date
string
response_from_delivery_carrier
boolean
retailer_moniker
string
scheduling
Scheduling
service_code
string
service_description
string
ship_date
string
shipper_account_number
string
signature
Signature
source
string
status
string
status_category
string
status_code
string
status_description
string
status_summary
string
status_token
string
track_url_tracking_id
string
tracking_number
string
tracking_status_code_id
string
weight
string
weight_uom
string
Address
Object
city
string
country
string
house_number
string
landmark
string
lat
string
lng
string
location_name
string
location_type
string
state
string
street1
string
street2
string
time_zone_id
string
zipcode
string
Customer
Object
contact
Contact
id
string
notification_preferences
Array of string
tier
string
type
string
PickupStatus
Object
code
string
date
string
message
string
PickupItem
Object
item_id
string
quantity
integer int32
sku
string
PickupStoreHour
Object
close
string
open
string
ExchangeItem
Object
attributes
Object
additional properties
string
ext_id
string
product_sku
string
title
string
ShipmentInfo
Object
carrier
string
carrier_service
string
carrier_service_code
string
custom_attributes
Object
additional properties
string
customer_key
string
customer_option
string
discount
string
id
string
items
Array of OrderItem
retailer_promise_date
string
ship_date
string
ship_from
Contact
ship_method
string
ship_source
string
ship_to
Contact
shipping_amount
string
tax
string
tracking_number
string
StatusCodeMapping
Object
bucket
string
bucket_code
string
bucket_display_token
string
code
string
code_description
string
display_token
string
BillingDocument
Object
amount
string
billed_to
Contact
billing_address
Address
payments
Array of Payment
shipping_handling
string
tax_amount
string
tax_rate
string
PickupStoreAddress
Object
city
string
country
string
state
string
store_area
string
street1
string
street2
string
zip
string
Item
Object
active
boolean
back_ordered
boolean
categories
Array of string
color
string
color_id
string
currency
string
custom_attributes
Object
additional properties
string
description
string
dimensions
Dimensions
discount_amount
string
discount_percent
string
final_sale
boolean
final_sale_date
string
fulfillment_status
string
gift
boolean
id
string
image_url
string
item_id
string
line_number
string
name
string
parent_product_sku
string
pick_ticket
string
price
string
product_description_url
string
product_id
string
product_sku
string
product_type
string
promise_date
string
quantity
integer int32
reference_file
string
shipped_date
string
shop_runner_eligible
boolean
size
string
size_id
string
style
string
url
string
vendor
string
weight
string
weight_unit
string
Stops
Object
last_location
Address
preceding_stops
integer int32
total_stops
integer int32
Order
Object
billing_document
BillingDocument
created_date
string
custom_attributes
Object
additional properties
string
customer_id
string
customer_level
string
customer_type
string
fulfillment_status
string
gift
boolean
items
Array of Item
modified_date
string
order_number
string
pickups
Array of Pickup
placement_date
string
retailer_moniker
string
returns
Array of Return
riid
string
shipment_info
Array of ShipmentInfo
EventError
Object
code
string
description
string
Return
Object
carrier
string
currency
string
display_restocking_fee
boolean
estimated_refund
number float
express_upgrade_fee
number float
is_gift_return
boolean
is_restock_override_used
boolean
is_simple_return
boolean
locale
string
restocking_fee
number float
retailer
string
return_created_date
string
return_created_date_epoch
integer int64
return_from
ReturnFrom
return_handling_fee
number float
return_id
string
return_items
Array of ReturnItem
return_method
string
return_shipping_credit
number float
return_shipping_fee
number float
return_status
string
return_to
ReturnTo
return_tracking_number
string
rma_number
string
s3_label_path
string
ship_by_date
string
ship_by_date_epoch
integer int64
shipping_fee
number float
shipping_method
string
tax_amount
number float
version
string
NonDeliveryResponse
Object
activity
NdrActivity
created_at
string
nauth
string
source
string
Pickup
Object
attributes
Object
additional properties
string
carrier
string
created_date
integer int64
eta
string
id
string
item_infos
Array of PickupItem
modified_date
integer int64
order_number
string
pickup_by_date
string
pickup_id
string
retailer
string
retailer_order_number
string
ship_date
string
statuses
Array of PickupStatus
store
PickupStore
tracking_number
string
ttl
integer int64
type
string
ReturnFrom
Object
address
Address
email
string
fax
string
first_name
string
language
string
last_name
string
phone
string
phone_extension
string
ReturnTo
Object
address
Address
company
string
dc_name
string
email
string
fax
string
first_name
string
language
string
last_name
string
phone
string
phone_extension
string
Dimensions
Object
height
string
length
string
uom
string
weight
string
weight_uom
string
width
string
CarrierOrdinal
Object
event_source
string
event_source_descriptor
string
ordinal
integer int32
RedirectToHold
Object
eligible
boolean
has_nearby_locations
boolean
package_identifier
string
redirect_request_number
string
rth_scheduled
boolean
store_document
StoreDocument
Scheduling
Object
eligibility_message
string
eligibility_status
string
reason
string
reschedulable
boolean
schedulable
boolean
schedulable_api
boolean
schedule_later
boolean
scheduled
boolean
EddDerived
Object
date
string
powered_by
string
source
string
AtlasResponse
Object
customer
Customer
order
Order
tracking
Array of Tracking
PickupStore
Object
address
PickupStoreAddress
hours
Array of PickupStoreHour
id
string
name
string
phone_number
string
url
string
Contact
Object
address
Address
email
string
fax
string
first_name
string
language
string
last_name
string
phone
string
phone_extension
string
Audit
Object
audit_record_saved
boolean
date
string
message_origin
string
Payment
Object
amount
number float
gift_card
boolean
merchant
string
merchant_ref
string
method
string
payment_card
string
payment_ref
string
StoreDocument
Object
contact_detail
Contact
distance
string
distance_unit
string
id
string
location_hours
Array of StoreOperationHoursDocument
name
string
NdrActivity
Object
location
Address
name
string
phone_number
string
reason
string
requested_date
string
StoreOperationHoursDocument
Object
closed_all_day
boolean
day_of_week
string
open_all_day
boolean
operation_hours
Array of string
OrderItem
Object
item_id
string
product_sku
string
quantity
integer int32
Signature
Object
carrier_code
string
carrier_description
string
code
string
narvar_code
string
required
boolean
Event
Object
carrier_moniker
string
carrier_ordinal
CarrierOrdinal
carrier_status_code
string
created_date_epoch
integer int64
date
string
date_raw
string
date_with_derived_offset
string
description
string
exception
EventError
location
Address
modified_date_epoch
integer int64
raw_code
string
status_code_mapping
StatusCodeMapping
Delivery
Object
appointment_window_begin
string
appointment_window_end
string
edd_begin
string
edd_end
string
guaranteed_date_begin
string
stops
Stops