Ground End of Day Close API

Introdução

A API de fechamento de fim do dia do Ground^® permite conciliar as informações de remessa para sua conta FedEx Ground e imprimir um manifesto de terra para seu motorista. O manifesto de terra é gerado depois de um fechamento realizado com sucesso e deve ser impresso antes de remessas por terra serem entregues à FedEx. Um cliente pode continuar a fazer remessa de pacotes por terra mesmo depois de um fechamento ser realizado.

Detalhes da API de fechamento de fim do dia no Ground

Com essa API você pode enviar os dados do pacote para a FedEx e gerar relatórios de manifesto, fechando assim a remessa FedEx Ground^® correspondente (nacional dentro dos EUA e internacional).

Funcionalidades da API de fechamento de fim do dia no Ground:

Todas as remessas com o mesmo campo de referência podem ser agrupadas e fechadas como um conjunto.
A funcionalidade de confirmação de referência identifica o subconjunto de remessas para as quais os relatórios configurados serão impressos.
A funcionalidade de fechamento de fim do dia com designação de referência para fechamento realiza a operação de fechamento para as remessas. Essas remessas são associadas com o campo de referência especificado.
Essa API envia as informações da remessa por terra para a conta FedEx.
A funcionalidade de verificação de erro de remessa aberta designa o nível de tratamento de erro a ser retornado em uma resposta. Ela pode ser usada para analisar as Remessas abertas não confirmadas ao realizar a transação de Fechamento de Fim do dia.

Como a API de fechamento de fim do dia no Ground funciona

A seguir, apresentamos algumas operações que ocorrem sob a API de fechamento de fim do dia FedEx Ground:

Solicitação de fechamento de fim do dia no Ground

Inicia a etapa final de processamento de todos os dados das remessas enviadas pelo cliente no dia (encerramento do horário comercial) para remessas pelo FedEx Ground. A resposta retorna apenas o manifesto de terra. O manifesto de terra está disponível apenas em formato de texto (.txt).

A seguir estão as informações essenciais associadas a esta solicitação:

Data de fechamento
Especificações de documentação/relatórios da remessa
Número de conta FedEx
Categoria FedEx Ground (FedEx Ground)

A resposta bem sucedida vai fechar as remessas e gerar os relatórios/documentos especificados.

Solicitação para nova impressão de documentos

Gera os relatórios especificados pelo usuário que são criados quando a operação de fechamento é processada. Retorna todos os relatórios especificados para um dia específico. É possível reimprimir relatórios de até três dias passados.

A seguir estão as informações essenciais associadas a esta solicitação:

Data de fechamento
Operação de reimpressão
Especificações de documentação/relatórios da remessa
Número de conta FedEx
Categoria FedEx Ground (FedEx Ground)

A resposta bem sucedida vai reimprimir os relatórios/documentos.

Fechamento do Ground

A operação de fechamento pode ser realizada várias vezes durante o dia de remessa. Não é preciso reabrir quando um fechamento tiver sido processado; basta continuar a remessa. Use o serviço de fechamento para iniciar o processamento da etapa final dos dados das remessas enviadas no dia (encerramento do horário comercial).

Para informações mais detalhadas sobre os serviços oferecidos pela FedEx, consulte o Guia de Serviços FedEx eletrônico.

Relatórios do FedEx Ground

Manifesto de terra

Depois da conclusão de uma atividade de etiqueta de remessa do FedEx Ground para o dia atual, o cliente deve \"fechar\" suas etiquetas FedEx Ground pendentes e imprimir um Manifesto FedEx Ground e entregar esse manifesto ao motorista FedEx ou ao funcionário do varejo. O manifesto lista todas as atividades de impressão do FedEx Ground e é obrigatório para o processamento pela FedEx.

O relatório do manifesto FedEx Ground pode ser impresso ou reimpresso a qualquer momento imediatamente depois do fechamento de fim do dia ou em um momento posterior, se houver mais de um fechamento para o dia. O relatório do manifesto FedEx Ground incluirá todas as remessas FedEx Ground geradas nas últimas 24 horas.

O manifesto de coleta FedEx Ground para os serviços consolidados FedEx é idêntico ao relatório padrão gerado para qualquer tipo de remessa de pacote FedEx Ground. O Manifesto de Coleta FedEx Ground é necessário para que o entregador FedEx Ground ofereça os pacotes para remessa. Ele fornece um resumo dos pacotes coletados em um determinado dia para o entregador FedEx Ground e fornece as informações a seguir:

Número da conta do remetente
Número de medição do remetente
Número de rastreio para todos os pacotes
Valor C.O.D. (se aplicável)
Valor declarado (se aplicável)
Número de pacotes de grandes dimensões I
Número de pacotes de grandes dimensões II
Número de pacotes que necessitam de tratamento adicional
Número de pacotes para entrega residencial
Número total de pacotes
Número de confirmação da coleta

Regras do negócio

A operação de fechamento é opcional, mas recomendada. Ela pode ser necessária se você precisar de qualquer um dos relatórios gerados.
É possível excluir remessas FedEx Ground depois de um fechamento.
O endereço no cabeçalho do manifesto é extraído do primeiro pacote remetido no dia especificado.

Coleção JSON API

Ship EndofDayClose API (1.0.0)

Ground End Of Day Close

Use this endpoint to close the Ground shipments and generate the reports.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema_GEOD_PUT
MinimumSamplePayload-Put-GroundClose

closeReqType	string Enum: "GCDR" "RGCDR" Specify the close request type to initiate processing of shipment data.For ground close the closeReqType is GCDR and for Reprint EndofDay the applicable value is RGCDR.
accountNumber	object (AccountNumber_2) This is the FedEx Account number. Example: XXX456XXX
groundServiceCategory	string Value: "GROUND" This is to specify FedEx ground category for which the shipment to be submitted for end of the day closing.
closeDate	string Indicates the close date. Example: 2020-05-05
trackingNumber	string Specify the tracking number for reprinting the report.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint. Example: 7XX96XX42946
reprintOption	string Enum: "BY_SHIP_DATE" "BY_TRACKING_NUMBER" Specify the reprint option to generate report. Either by close date or a tracking number.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint.
closeDocumentSpecification	object (CloseDocumentSpecification) Specifies characteristics of the document to be returned for this request.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/endofday/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/endofday/

Production Server

https://apis.fedex.com/ship/v1/endofday/

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"closeReqType": "GCDR",
"accountNumber":
{
- "value": "123456789"
},
"groundServiceCategory": "GROUND",
"closeDate": "2020-05-05",
"trackingNumber": "794967542946",
"reprintOption": "BY_SHIP_DATE",
"closeDocumentSpecification":
{
- "closeDocumentTypes":
  [
  - "OP_950"
  ],
- "op950Detail":
  {
  - "format":
    {
    "topOfPageOffset":
    {
    "value": "0",
    "units": "CM"
    },
    "imageType": "PDF",
    "stockType": "OP_950",
    "locale": "en_US"
    }
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"output":
{
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ],
- "closeDocuments":
  [
  - {
    "type": "OP_950",
    "shippingCycle": "1003234523333204",
    "shippingDocumentDisposition": "CONFIRMED",
    "accessReference": null,
    "resolution": 200,
    "copiesToPrint": 1,
    "parts":
    [
    {
    "documentPartSequenceNumber": 1,
    "image": "ICAgICAg.."
    }
    ]
    }
  ]
}

}

Reprint End of the day

Use this endpoint to reprint the closed Ground shipments reports.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema_Reprint_POST
MinimumSamplePayload-Post-Reprintground

closeReqType	string Enum: "GCDR" "RGCDR" Specify the close request type to initiate processing of shipment data.For ground close the closeReqType is GCDR and for Reprint EndofDay the applicable value is RGCDR.
accountNumber	object (AccountNumber_2) This is the FedEx Account number. Example: XXX456XXX
groundServiceCategory	string Value: "GROUND" This is to specify FedEx ground category for which the shipment to be submitted for end of the day closing.
closeDate	string Indicates the close date. Example: 2020-05-05
trackingNumber	string Specify the tracking number for reprinting the report.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint. Example: 7XX96XX42946
reprintOption	string Enum: "BY_SHIP_DATE" "BY_TRACKING_NUMBER" Specify the reprint option to generate report. Either by close date or a tracking number.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint.
closeDocumentSpecification	object (CloseDocumentSpecification) Specifies characteristics of the document to be returned for this request.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/endofday/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/endofday/

Production Server

https://apis.fedex.com/ship/v1/endofday/

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"closeReqType": "GCDR",
"accountNumber":
{
- "value": "123456789"
},
"groundServiceCategory": "GROUND",
"closeDate": "2020-05-05",
"trackingNumber": "794967542946",
"reprintOption": "BY_SHIP_DATE",
"closeDocumentSpecification":
{
- "closeDocumentTypes":
  [
  - "OP_950"
  ],
- "op950Detail":
  {
  - "format":
    {
    "topOfPageOffset":
    {
    "value": "0",
    "units": "CM"
    },
    "imageType": "PDF",
    "stockType": "OP_950",
    "locale": "en_US"
    }
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"output":
{
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ],
- "closeDocuments":
  [
  - {
    "type": "OP_950",
    "shippingCycle": "1003234523333204",
    "shippingDocumentDisposition": "CONFIRMED",
    "accessReference": null,
    "resolution": 200,
    "copiesToPrint": 1,
    "parts":
    [
    {
    "documentPartSequenceNumber": 1,
    "image": "ICAgICAg.."
    }
    ]
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Ground End of Day Close API

Introdução

Detalhes da API de fechamento de fim do dia no Ground

Como a API de fechamento de fim do dia no Ground funciona

Fechamento do Ground

Relatórios do FedEx Ground

Regras do negócio

Coleção JSON API

Ship EndofDayClose API (1.0.0)

Ground End Of Day Close

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Reprint End of the day

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in